Jayteemighty / Pbreport-backend

A backend to a report selling site(official)

Pbreport-backend - API Documentation

Welcome to the API documentation! This document provides information on how to access and explore the API endpoints using Swagger.

Tech Stack

The E-Commerce Django Store utilizes the following technologies and frameworks:

• Python: A powerful programming language used for the backend development.
• Django REST framework: A powerful and flexible toolkit for building Web APIs.
• Git: A distributed version control system used for tracking changes in source code during software development.

How to Run the Project

To run the E-Commerce Django Backend on your local machine, follow these steps:

Cloning the Repository

To access the source code and documentation, follow these steps:

1. Open your terminal or command prompt.

2. Navigate to the directory where you want to clone the repository.

3. Use the following command to clone the repository:

   git clone https://github.com/Jayteemighty/Pbreport-backend.git
   

Running the Server

Before accessing the API documentation, ensure that you have the necessary dependencies installed and the server running. Follow these steps:

1. Navigate to the root directory of the cloned repository.

2. Install the required dependencies using the following command:

   pip install -r requirements.txt
   

3. Start the server by running the following command:

   python manage.py runserver
   

Accessing API Documentation

1. To access the API documentation using Swagger, follow these steps:

2. Open your web browser. Enter the following URL in the address bar:

   http://localhost:8000/swagger/
   

This URL points to the Swagger UI interface for the API documentation.

3. Press Enter to navigate to the Swagger interface.

4. Explore the API endpoints, request parameters, and response schemas using the Swagger UI.

Conclusion

The API documentation provides comprehensive information on the available endpoints and how to interact with them. If you have any questions or issues, feel free to reach out through [e-mail].

Thank you for using our API!

NOTE: Open to corrections. Please feel free to make any necessary changes.