Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zgramming/book-store-be
Rasa Group Book Store Backend
https://github.com/zgramming/book-store-be
express-js prisma
Last synced: 1 day ago
JSON representation
Rasa Group Book Store Backend
- Host: GitHub
- URL: https://github.com/zgramming/book-store-be
- Owner: zgramming
- Created: 2024-04-05T09:08:27.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T07:20:01.000Z (7 months ago)
- Last Synced: 2024-05-14T00:04:39.000Z (6 months ago)
- Topics: express-js, prisma
- Language: TypeScript
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.MD
Awesome Lists containing this project
README
# RESTful API Node Express
The project builds RESTful APIs using Node.js, Express for Library Web Apps
## Manual Installation
```bash
git clone https://github.com/zgramming/book-store-be.git
cd book-store-be
```
Install the dependencies:
```bash
npm install
```
Set the environment variables:
```bash
cp .env.example .env
# open .env and modify the environment variables
```
Running Migration for Database
```bash
npm run prisma:build
```
## Table of Contents
- [Commands](#commands)
- [Environment Variables](#environment-variables)
- [API Endpoints](#api-endpoints)
## Commands
Running in development:
```bash
npm run dev
```
Running in production:
```bash
# build
npm run build
# start
npm run start
```
## Environment Variables
The environment variables can be found and modified in the `.env` file.
```bash
# Database Location
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/book_store?schema=public"
# JWT Secret
JWT_SECRECT_KEY="6da654d8-b691-4391-8340-e49882447c2c" # You can ignored it
```
### API Endpoints
List of available routes:
**Master Book routes**:\
`GET api/v1/master-books` - Get All Books\
`GET api/v1/master-books/:id` - Get Book by id\
`POST api/v1/master-books` - Create Book\
`PUT api/v1/master-books/:id` - Update Book\
`DEL api/v1/master-books/:id` - Delete Book
**Master Student routes**:\
`GET api/v1/master-students` - Get All Students\
`GET api/v1/master-students/:id` - Get Student by id\
`POST api/v1/master-students` - Create Student\
`PUT api/v1/master-students/:id` - Update Student\
`DEL api/v1/master-students/:id` - Delete Student
**Inventory routes**:\
`GET api/v1/inventories` - Get All Inventories\
`GET api/v1/inventories/:id` - Get Inventory by id\
`POST api/v1/inventories` - Create Inventory\
`PUT api/v1/inventories/:id` - Update Inventory\
`PUT api/v1/inventories/:id/increase-stock` - Increase stock inventory\
`PUT api/v1/inventories/:id/decrease-stock` - Decrease stock inventory\
`DEL api/v1/inventories/:id` - Delete Inventory
**Transactions routes**:\
`GET api/v1/transactions` - Get All Transactions\
`GET api/v1/transactions/:id` - Get Transaction by id\
`POST api/v1/transactions` - Create Transaction\
`PUT api/v1/transactions/:id/return` - Return book
**History routes**:\
`GET api/v1/history-transactions` - Get All History Transactions