Skip to content

lmtri2307/Simpface

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

SimpFace

SimpFace is a simplified version of Facebook, offering basic social media functionalities. Users can create accounts, post status updates and pictures, follow other users to see their posts, comment on posts, and engage in real-time chatting.

Demo Video

Check out the demo video of the SimpFace here.

Features

  • User Registration: Users can create accounts to access the SimpFace platform.
  • Posting: Users can share status updates and pictures with their followers.
  • Following: Users can follow other users to see their posts in their feed.
  • Comments: Users can comment on posts to engage in discussions.
  • Real-time Chatting: Users can engage in real-time chats with each other.
  • Authentication: JWT tokens are used to authenticate users and protect routes.
  • ReactJS Front-end: The front-end of SimpFace is developed using ReactJS.

Technologies Used

  • Node.js: The back-end of SimpFace is developed using Node.js.
  • Express.js: Express.js is used as the web application framework for the back-end.
  • Socket.io: Socket.io enables real-time chatting functionality in SimpFace.
  • JWT (JSON Web Tokens): JWT is used for user authentication.
  • ReactJS: The front-end of SimpFace is built using ReactJS.

Getting Started

To run SimpFace locally, follow these steps:

  1. Clone the repository: git clone https://github.com/lmtri2307/Simpface
  2. Navigate to the back-end directory: cd sever
  3. Install the required dependencies: yarn install
  4. Start the back-end server: yarn start
  5. Open a new terminal window and navigate to the front-end directory: cd client
  6. Install the required dependencies: yarn install
  7. Start the front-end development server: yarn start

Usage

Once the back-end and front-end servers are running, users can access the SimpFace platform by opening a web browser and visiting http://localhost:3000. From there, they can register an account, log in, and start using SimpFace's features, including creating posts, following other users, commenting on posts, and engaging in real-time chatting.

Contributing

Contributions to SimpFace are welcome! If you would like to contribute, please fork the repository, make your changes, and submit a pull request.