Skip to content

Quantum Space a social media app built with React.js, JavaScript, Node.js, Express.js, MongoDb, Mongoose

Notifications You must be signed in to change notification settings

damnanuj/quantum-space

Repository files navigation

⚠️ Note: The frontend is still in progress and will be updated once it's done.

Quantum-Space API Documentation

Quantum Space is a social media platform where users can post updates, interact with each other, and stay informed through notifications. This documentation provides a comprehensive guide on how to interact with Quantum-Space's API endpoints for authentication, posts, notifications, and user management.

Frontend Preview

You can log in using the credentials below if you prefer not to sign up:

image image image

Feel free to signup with the actual values for better usability.

Table of Contents

  1. Introduction
  2. API Modules
  3. Getting Started
  4. Endpoints

Introduction

Quantum-Space APIs are designed for developers to easily integrate social features into their applications. Whether you're looking to enable user registration, manage posts, or notify users, these endpoints make it simple.


API Modules

Each API module focuses on a specific aspect of Quantum-Space functionality. For detailed information on the routes and usage instructions, please refer to the respective module documentation below.

  • Authentication - auth.md: Handles user registration, login, and logout.
  • Posts - posts.md: Allows users to create, edit, and delete posts.
  • Notifications - notifications.md: Provides notification management.
  • User - user.md: Manages user profiles, follow/unfollow actions, and profile updates.

Getting Started

To use these APIs, set up your environment with the required dependencies and start the server. Ensure to configure any necessary environment variables, such as database URIs or secret keys for JWT.

  1. Clone the repository: git clone <repo-url>
  2. Install dependencies: npm install
  3. Start the server: npm start

Endpoints

Each API module contains information on the routes, request methods, expected parameters, and responses. For complete details, see the links to each module’s documentation.

Happy coding with Quantum-Space!

⚠️ Note: The frontend is still in progress and will be updated once it's done.


Project Links

About

Quantum Space a social media app built with React.js, JavaScript, Node.js, Express.js, MongoDb, Mongoose

Topics

Resources

Stars

Watchers

Forks