Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

Sociopedia

This is a social media web application. It allows users to sign up, log in, post images with captions, make friends with other users, and like other users' posts.

Features

• Login and signup
• Post images and add captions
• Make friends
• Like other users' posts
• See a feed of all posts from your friends
• See a list of all your friends

Built With

• 

• 

• 

• 

• 

• JWT (Json Web Token)

Getting Started

This is an example of how you setting up project locally. To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get a MongoDB Atlas Application connection URL at https://www.mongodb.com/home by creating the database.
2. Clone the repo

   git clone https://github.com/Dharmik3/sociopedia.git

3. Install NPM packages

   cd client
   npm install
   
   cd server
   npm install

4. Create .env file and put MongoDB url in .env in server directory

    MONGO_URL = ENTER YOUR MONGO URL (without inverted commas);
   JWT_SECRET = ENTER YOUR SECRET 

5. Run following command in terminal inside client directory

   npm start

6. Run following command in terminal inside server directory

   npm run server

(back to top)

Usage

Now you can test your url on your browser url

  http://localhost:3000/

Server is running on 5001 PORT

For more examples, please refer to the live link

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Dharmik Patel - @Dharmik - dharmikpatel.pepalla@gmail.com

(back to top)