LINE Travel Hotel Assignment

Slide: https://docs.google.com/presentation/d/1EKCk1ftGjdvLh7Fq7_1O8BQgpnX-XrR7q0IQ3URR0Fw/edit?usp=sharing
API docs: https://demo.ytli.tw/docs

How to run

For development

1. add .env.development to root folder, please refer to .env.example
2. start the local db using docker container for development

• docker compose --profile development --env-file .env.development up -d

3. install dependencies

• npm i

4. start the app

• npm run start:dev

For production

1. add .env.production to root folder, please refer to .env.example
2. start the app

• docker compose --profile production --env-file .env.production up -d

App Feature

Hotels

• Get hotel by id
• Get all hotel with pagination
• Create hotel
• Update hotel
• Batch insert hotel with csv file
  • allow partial success imports
  • check missing field
  • check wrong types
  • allow empty rows in csv

Users

• Login
  • Issue JWT for authorization
  • Refresh JWT access token by Cookie
• Sign Up (Create User)
• Get user by ID
• Update user data (required authentication)

Technologies

• Nest.js framework
• MySQL with TypeORM
• Jest for unit testing
• supertest for e2e testing
• Containerization with Docker
• Github and Github actions
• Nginx for reverse proxy and add TLS certs
• Swagger for API Docs

Architecture