Skip to content

mamalli11/book-store

Repository files navigation

Project logo

Online Book Store

Status GitHub Issues GitHub Pull Requests License


An online book store application built with Nest.js, featuring CRUD operations for books, authors, publishers, translators, and categories. It also supports features like discount codes, shopping cart, and Zarinpal payment gateway.

📝 Table of Contents

🧐 About

This project is an online bookstore application built using Nest.js and PostgreSQL for database management. The system provides APIs for managing books, authors, publishers, translators, and categories. Users can also submit reviews for books, apply discount codes, and finalize their purchases through the Zarinpal payment gateway. The application is integrated with AWS for image management and uses Swagger for API documentation.

🏁 Getting Started

These instructions will help you set up the project on your local machine for development and testing purposes.

Prerequisites

You'll need the following software installed:

  • Node.js
  • PostgreSQL
  • Zarinpal Payment Gateway credentials
  • AWS credentials for image management

Installing

Clone the repository:

git clone https://github.com/mamalli11/book-store.git
cd book-store

Install dependencies:

npm install

Rename the file from .env.local to .env and fill in the requested values.

Start the development server:

npm run start:dev

🎈 Usage

Once the server is running, you can access the API at http://localhost:3000. Use Swagger for API documentation by visiting http://localhost:3000/swagger.

🚀 Deployment

To deploy the application:

  1. Set up a PostgreSQL instance on your server or cloud service.
  2. Set environment variables for your production environment.
  3. Run npm run build to create a production build.
  4. Start the application with npm run start.

⛏️ Built Using

✍️ Authors

See the list of contributors who participated in this project.

🎉 Acknowledgements

  • Thanks to the open-source community for the inspiration and resources.