Skip to content

Latest commit

 

History

History
38 lines (34 loc) · 1.92 KB

README.md

File metadata and controls

38 lines (34 loc) · 1.92 KB

License: MIT Javascript

Connect

A social networking web app made using MERN Stack. Here users will be able to post their memories, like, comment and follow other users and posts.

Technologies Used

  • NodeJs
  • Express
  • MongoDb
  • ReactJs
  • MaterialUI

Key Features

  • User Authentication -- using bcrypt library to hash passwords
  • GeoLocating users -- using HTML5 GeoLocating API
  • Push Notifications -- using WebPush and Service Workers

Implementation

  • The database schema for the web app is located at models/ folder
  • The implementation of all the REST API end points can be found in routes/ folder
  • The implementation of authorization step can be found in authenticate.js file in the root folder
  • All the client side development can be found in client/ folder
  • Used Socket.io library for real time communication between client and server to display users locations on map

Deployment steps


  • Clone the entire repository to a new folder on desktop
  • Open the command prompt from the same folder and type npm install. This will download all the required dependencies which are present in package.json file
  • Now open the mongodb terminal and create a new database named User. All the data of users and posts will be stored here.
  • For doing unit tests type the command npm run test. This will do the unit tests on different end points for sanity checking.
  • To start the server enter the command npm start