Social Media API

A social media API built with Node.js, Express.js, and MongoDB. This API is built for developers to use in their projects. It is not meant to be used as a standalone social media platform. This API is still in development and is not ready for production use.

Table of Contents

• Social Media API
  • Table of Contents
  • Features
  • Upcoming Features
  • Getting Started
    • Prerequisites
    • Installation
    • Configuration
    • Database Setup
    • Running the Application
  • API Documentation
    • Authentication
    • Endpoints
      • Auth
      • Post
  • Deployment
  • Technologies Used
  • Contributing
  • License
  • Sponsor Me
  • Connect With Me
  • Activities

Features

• User authentication and authorization.
• CRUD operations for users, posts, and notifications.
• JWT-based authentication for secure API access.
• RESTful API design.
• Written in TypeScript for enhanced maintainability and type safety.

Upcoming Features

• Personal Chat
• Group Chat
• End-To-End Encryption in Chat

Getting Started

You can follow these instructions to get the project up and running on your local machine.

Prerequisites

You need to have the following software installed on your computer:

• Bun (v1.1.0 or later) or Node.js (LTS version recommended)
• npm, pnpm, Yarn or Bun package manager

Installation

1. Star the repository.

2. Clone this repository to your local machine using the following command:

   git clone https://github.com/nixrajput/social-media-api-nodejs.git

3. Navigate to the project directory:

   cd social-media-api-nodejs

4. Install the project dependencies:

   If you're using npm:

   npm install

   If you're using pnpm:

   pnpm install

   If you're using Yarn:

   yarn install

   If you're using bun:

   bun install

Configuration

Before running the application, you need to configure the environment variables. Copy the .env.example file to .env.local and fill in the necessary values.

cp .env.example .env.local

Database Setup

Make sure you have a database configured and running. Update the database connection details in the .env.local file.

Running the Application

Once the dependencies are installed and the configuration is set up, you can start the application by running:

npm run dev
#or
pnpm run dev
# or
yarn dev
# or
bun run dev

By default, the application will run on port 3000. You can change the port by modifying the PORT environment variable in the .env.local file.

API Documentation

Authentication

The API uses JWT (JSON Web Tokens) for authentication. To authenticate, send a POST request to /api/v2/auth/login with a JSON payload containing the user's email and password.

{
  "email": "user@example.com",
  "password": "password"
}

If the credentials are valid, the API will respond with a JWT token, which should be included in subsequent requests as an Authorization header:

Authorization: Bearer <token>

Endpoints

Auth

• POST /api/v2/auth/register: Create a new account.
• POST /api/v2/auth/login: Login to the account.
• GET /api/v2/auth/me: Get profile details.

Post

• GET /api/v2/post/create: Create a new post.
• GET /api/v2/post/feed: Get post feed.

Deployment

This API can be deployed using various platforms such as Heroku, AWS, Google Cloud Platform, or your own server infrastructure. Here are some general steps to deploy the API:

1. Prepare your environment: Ensure that your deployment environment meets the requirements specified in the Prerequisites section.

2. Build the application: If necessary, build the TypeScript code into JavaScript. You can do this by running:

   npm run build

   or

   yarn build

   or

   bun run build

3. Configure environment variables: Set up environment variables similar to how it's done in the local setup. Ensure that you provide appropriate values for your deployment environment.

4. Deploy the application: Deploy the built application to your chosen platform. Each platform may have its own deployment process. Refer to the documentation of your chosen platform for detailed instructions.

5. Start the application: Once deployed, start the application in your deployment environment. This might involve running a command similar to npm start or yarn start, depending on your setup.

6. Monitor the deployment: Monitor the deployed application for any issues. Make sure that it's running smoothly and handle any errors or performance issues as needed.

Technologies Used

• Node.js
• Express.js
• Bun
• TypeScript
• MongoDB

Contributing

If you would like to contribute to this project, feel free to fork the repository, make your changes, and submit a pull request. Please follow the guidelines in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Sponsor Me

By sponsoring my efforts, you're not merely contributing to the development of my projects; you're investing in its growth and sustainability.

Your support empowers me to dedicate more time and resources to improving the project's features, addressing issues, and ensuring its continued relevance in the rapidly evolving landscape of technology.

Your sponsorship directly fuels innovation, fosters a vibrant community, and helps maintain the project's high standards of quality. Together, we can shape the future of the projects and make a lasting impact in the open-source community.

Thank you for considering sponsoring my work!

Connect With Me

Activities