Skip to content

vins-anity/Know-Your-Neighborhood-Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Know-Your-Neighborhood👈

Introducing Know Your Neighborhood, a web application that provides users with valuable information about their local community. This application offers user registration, seamless Facebook OAuth2 login, store posting and searching features, and the ability to manage personal profiles.

Project Overview

The Know-Your-Neighborhood website consists of the following Key pages

  1. Home Page ✔️
  2. Registration Page ✔️
  3. Login Page with social login (Facebook) ✔️
  4. Contact us Page ✔️
  5. About us Page ✔️
  6. Stores Page ✔️
  7. Store Detail Page ✔️
  8. Post Store ✔️
  9. View Profile page ✔️

Customers can login using the existing API and fetch basic information such as name, email from API.

Technologies Used & System Requirements

Backend : Java SE 11 🔥, MySQL 8 🔥, Spring Boot 🔥, Spring Security 🔥, OAuth2 (Facebook API) 🔥, Restful API 🔥
Frontend : React 🔥, Tailwindcss 🔥, Axios 🔥, React-hook-form 🔥, React-router-dom 🔥
Tools : Node Js (LTS Ver)

HOW TO RUN

Backend

  1. Import Existing Project into Visual Studio Code
  2. Create MySQL database
mysql> create database example
  1. Setup application.yml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/example
    username: <YOUR_DB_USERNAME>
    password: <YOUR_DB_PASSWORD>

  jpa:
    show-sql: true
    hibernate:
      ddl-auto: update
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQL8Dialect
  security:
    oauth2:
      client:
        registration:
          facebook:
            clientId: <YOUR_FACEBOOK_CLIENTID>
            clientSecret: <YOUR_FACEBOOK_CLIENTSECRET>
            redirectUri: http://localhost:8080/oauth2/callback/facebook
            scope:
              - email
              - public_profile
        provider:
          facebook:
            authorizationUri: https://www.facebook.com/v3.0/dialog/oauth
            tokenUri: https://graph.facebook.com/v3.0/oauth/access_token
            userInfoUri: https://graph.facebook.com/v3.0/me?fields=id,name,email,picture.width(250).height(250)

app:
  auth:
    tokenSecret: <YOUR_TOKEN_SECRET> (you can go to generator online for token secret)
    tokenExpirationMsec: 86400000
  oauth2:
    authorizedRedirectUris:
      - http://localhost:3000/oauth2/redirect
  1. Get Client ID & Client Secret Facebook API
  1. Run Java Application

Frontend

  1. Import existing project to your Text Editor/IDE and run NPM Install
npm install
  1. Run React application with NPM Start (Make sure the backend is also running in the localhost:8080)
npm start
  1. Open http://localhost:3000 to view it in the browser.

Screenshot

Home Page

home_page

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages