Skip to content

utsavk28/Social

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Stargazers Issues LinkedIn


Logo

A Social Media Web App with Real Time Chat features
Explore the Web App »

Web App · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

It is Social Media Web App with Real Time Chat Feature

  • Home Page Social Home Page
  • Profile Page Social Profile Page
  • Chat Page Social Chat Page

Features

  • CRUD operation on Posts, Profile and Comments
  • Like/Unlike Post & Comments
  • Follow/Unfollow Users
  • Chat with your Friends with Real Time Chat Feature
  • Save Posts
  • Explore Page

Built With

Getting Started

Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Get a Mongo URI from https://cloud.mongodb.com/
  2. Clone the repo
    git clone https://github.com/utsavk28/Social
  3. Install NPM packages
    cd client && npm install
    cd server && npm install
  4. Enter your Mongo URI and JWT Secret Token in server/config/default.json
    {
     	"mongoURI": "mongodb+srv://user:pass@cluster10.uxypi.mongodb.net/test?retryWrites=true&w=majority",
     	"jwtSecret": "token"
     }

Usage

Allows individuals to keep in touch with friends and extended family

Roadmap

See the open issues for a list of proposed features (and known issues).

  • Phase 1
    • CRUD Operations on Posts, Comments and Profile
    • CRUD operation on Posts, Profile and Comments
    • Like/Unlike Post & Comments
  • Phase 2
    • Follow/Unfollow Users
    • Chat with your Friends with Real Time Chat Feature
    • Save Posts
    • Explore Page
  • Phase 3
    • .

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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 for more information.

Contact

Your Name - Utsav Khatu

Project Link: https://github.com/utsavk28/Social

Acknowledgements