Welcome to the backend repository for the Book Store application! This project serves as the backend infrastructure for managing the book store's inventory, handling user authentication, and facilitating order management. The backend is built using Django Rest Framework and deployed using Docker Compose.
The Book Store backend provides a robust and secure API for interacting with the book store application. It handles tasks such as user authentication, book management, order processing, and more.
- User Authentication: Secure authentication mechanisms are implemented to ensure that only authorized users can access the application.
- Book Management: API endpoints are available for managing book listings, including adding new books, updating existing listings, and removing books from the inventory.
- Order Processing: Endpoints for managing orders, including viewing order details, updating order status, and handling order fulfillment.
- Docker Compose: Services are containerized using Docker Compose, allowing for easy deployment and scaling of the backend infrastructure.
To set up the Book Store backend locally using Docker Compose, follow these steps:
-
Clone this repository:
git clone https://github.com/sjdfani/book_store_backend.git
-
Navigate to the
book_store_backend
directory:cd book_store_backend
-
Create a
.env
file in the root directory and define environment variables as needed. Refer to.env.example
for an example configuration. -
Build and start the Docker containers:
docker-compose up --build
-
Once the containers are running, the backend services should be accessible at
http://127.0.0.1:8000
.
Access the API endpoints using tools like Postman or integrate them into your frontend application. The documentation for the API endpoints can be found in the API documentation.
The Book Store backend exposes the following API endpoints:
- Books:
/api/books/
- Carts:
/api/cart/
- Users:
/api/users/
For detailed documentation on each endpoint and their usage, refer to the API documentation.
Contributions to the Book Store backend are welcome! To contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive messages.
- Push your changes to your fork.
- Submit a pull request to the
main
branch of the original repository.
This project is licensed under the MIT License.