Sociial

This is the backend for Sociial, a social media app built with Node.js, Express.js, Socket.IO, and MongoDB. The backend handles user authentication, real-time messaging (chats, group chats, reacts), media management (posts, videos, comments, likes), audio/video calls (WebRTC) and much more.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/sethshivam11/sociial.git

2. Install NPM packages

   npm install

3. Enter your environment variables in .env.local

    NEXT_PUBLIC_LINK=YOUR_LOCALHOST_URL
    BACKEND_URL=YOUR_BACKEND_URL
    NEXT_PUBLIC_SOCKET_URL=YOUR_BACKEND_URL
    NEXT_PUBLIC_FIREBASE_VAPID_KEY=YOUR_FIREBASE_VAPID_KEY
    NEXT_PUBLIC_FIREBASE_API_KEY=YOUR_FIREBASE_API_KEY
    NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=YOUR_FIREBASE_AUTH_DOMAIN
    NEXT_PUBLIC_FIREBASE_PROJECT_ID=YOUR_FIREBASE_PROJECT_ID
    NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=YOUR_FIREBASE_STORAGE_BUCKET
    NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=YOUR_FIREBASE_MESSAGING_SENDER_ID
    NEXT_PUBLIC_FIREBASE_APP_ID=YOUR_FIREBASE_APP_ID
    NEXT_PUBLIC_MAPS_API_KEY=YOUR_MAPS_API_KEY
   

4. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github-username/repo-url
   git remote -v # confirm the changes

Usage

You can use the project by visiting https://sociial.vercel.app/home

For API Documentation visit https://documenter.getpostman.com/view/37731620/2sAY4rGR2L

For backend code visit https://github.com/sethshivam11/social-media-backend

Contributing

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

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 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

Contact

Shivam - @sethshivam11 - sociial@gmail.com

Project Link: https://github.com/sethshivam11/sociial