https://github.com/anarbyrm/bookcommentingservice
A book review service.
https://github.com/anarbyrm/bookcommentingservice
nestjs nodejs sqlite typeorm typescript
Last synced: 15 days ago
JSON representation
A book review service.
- Host: GitHub
- URL: https://github.com/anarbyrm/bookcommentingservice
- Owner: anarbyrm
- Created: 2025-05-26T07:21:22.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-01T15:40:18.000Z (about 1 year ago)
- Last Synced: 2025-10-26T22:24:28.193Z (9 months ago)
- Topics: nestjs, nodejs, sqlite, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 244 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Url Shortener App
A simple book review service build with NestJS.
### About
This project allows users to create, get one, get all books and add reviews for specified book. Average rating is calculated for each book based on its reviews. Project is build using NestJS opinionated architecture using dependency injection. For data persistence SQLite is selected for the sake of simplicity and TypeORM to abstract SQL. Migration process is preferred instead using syncronize=true method for database table structure modification.
## Table of Contents
- [Installation](#installation)
- [Features](#features)
- [API Reference](#api-reference)
- [Swagger](#swagger)
## Installation
#### Clone the repository
```bash
git clone https://github.com/anarbyrm/BookCommentingService.git
```
#### Navigate into the directory
```bash
cd ./BookCommentingService
```
#### Build and up the project
```bash
npm start
```
You are ready to use project endpoints.
## Features
- Book and review create and listings
- SQLite database support for persistence and typeorm with migrations
- Swagger docs
## API Reference
| Endpoint | Method | Description |
| -----------------------------| ------ | --------------------------------|
| `/api/books` | POST | Creates new book |
| `/api/books` | GET | Fetch all books with reviews |
| `/api/books/:bookId` | GET | Fetch one book with reviews |
| `/api/books/:bookId/reviews` | GET | Create a review for a book |
## Swagger
All endpoints can be inspected in swagger docs. It can be accessed over `localhost:3000/swagger`.