Description

This is the backend for the Reading Sphere application. Our main goal is to transform non-readers into regular readers.

Api-Documentation

This is our Deployed VPS Api-Documentatoin , you can try it now!

http://20.116.220.162:3001/api-docs/#/

Startup Guide

1. Clone the repository:

   git clone https://github.com/The-Joesters/backend-codebase.git

2. Navigate into the project directory:

   cd backend-codebase

3. Install the required dependencies:

   npm install

4. Start the application:

   npm start

API Documentation

• Swagger UI: You can access the API documentation at:

  http://localhost:3000/api-docs

  This page provides interactive documentation of the API endpoints and allows you to test them.

Additional Information

• Configuration: Ensure you have a .env file for environment variables.

• Test API: Note that there is a test API included in the Swagger documentation. This endpoint is not functional yet, but it is present for future testing and development purposes.