Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lqqyt2423/reservation-system
https://github.com/lqqyt2423/reservation-system
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lqqyt2423/reservation-system
- Owner: lqqyt2423
- Created: 2024-05-15T01:42:37.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-26T07:44:19.000Z (7 months ago)
- Last Synced: 2024-11-06T03:32:25.851Z (about 2 months ago)
- Language: TypeScript
- Size: 363 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reservation System
## Development
### Backend
Ensure MongoDB is installed and running at `mongodb://localhost:27017/`. Or pass MONGO_URI env when start.
```bash
cd backend
npm install
npm run start:dev
```
### Frontend
```bash
cd frontend
npm install
npm run dev
```
## Tech Stack
### Backend
- MongoDB
- Nest.js
- TypeScript
Nest.js framework built on TypeScript, offers a modular and scalable architecture, ideal for complex applications. With support for both RESTful API and GraphQL endpoints, it enables clean code and clear architecture through its modular structure and dependency injection.
MongoDB is chosen as the database for its flexibility, scalability, and support for document-oriented data models, seamlessly integrating with Nest.js.
### Frontend
- React
- Vite
## Project Structure
- RESTful API for guest interactions
- GraphQL for employee interactions
Guest interactions with the backend utilize RESTful API, while restaurant operations leverage GraphQL API.
This design provides flexibility in interface selection, catering to different user needs:
- RESTful API simplifies guest interactions with standard HTTP methods.
- GraphQL empowers restaurant employees with advanced querying and mutation capabilities, ensuring precise data retrieval as needed.
## Test Report
### Run Test
```bash
cd backend
npm run test
npm run test:e2e
```
### Test Coverage
```bash
cd backend
npm run test:cov
```
```
-----------------------------|---------|----------|---------|---------|----------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-----------------------------|---------|----------|---------|---------|----------------------------------
All files | 48.53 | 15 | 35.48 | 48.96 |
src | 17.07 | 0 | 16.66 | 14.28 |
app.module.ts | 0 | 0 | 0 | 0 | 1-34
app.service.ts | 0 | 100 | 0 | 0 | 1-6
main.ts | 0 | 100 | 0 | 0 | 1-10
validation.pipe.ts | 43.75 | 0 | 33.33 | 35.71 | 14-17,26-33
src/reservations | 58.46 | 20 | 40 | 60 |
reservation.dto.ts | 92.3 | 100 | 0 | 90.9 | 11
reservation.model.ts | 100 | 100 | 100 | 100 |
reservations.controller.ts | 44.82 | 0 | 20 | 45.83 | 30-32,40-41,50-52,57-61
reservations.module.ts | 0 | 100 | 100 | 0 | 1-17
reservations.resolver.ts | 38.09 | 0 | 16.66 | 38.88 | 15,20-26,30-35,41-46,50-60,64-68
reservations.service.ts | 89.47 | 33.33 | 100 | 93.75 | 28
-----------------------------|---------|----------|---------|---------|----------------------------------
```
```bash
npm run test:e2e:cov
```
```
-----------------------------|---------|----------|---------|---------|----------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-----------------------------|---------|----------|---------|---------|----------------------------
All files | 72.56 | 15 | 63.33 | 73.18 |
src | 85.29 | 20 | 80 | 82.14 |
app.module.ts | 100 | 50 | 100 | 100 | 15
app.service.ts | 80 | 100 | 0 | 66.66 | 6
validation.pipe.ts | 75 | 0 | 100 | 71.42 | 15,30-33
src/reservations | 69.23 | 13.33 | 60 | 70.9 |
reservation.dto.ts | 100 | 100 | 100 | 100 |
reservation.model.ts | 100 | 100 | 100 | 100 |
reservations.controller.ts | 62.06 | 0 | 60 | 66.66 | 50-52,57-61
reservations.module.ts | 100 | 100 | 100 | 100 |
reservations.resolver.ts | 50 | 0 | 58.33 | 52.77 | 20,30-32,41-43,50-54,64-68
reservations.service.ts | 57.89 | 0 | 50 | 56.25 | 26-34,42-48
-----------------------------|---------|----------|---------|---------|----------------------------
```
## Screenshot
### Guest
### Employee
