Auto Driver is a NodeJS Ts.Ed (Express based) API that aims to control a small renting car app.
It is an awesome project based on this stack:
- Ts.ED framework (over ExpressJS)
- Typescript
- ESLint + Prettier
- NPM (as the default package manager).
- Local Swagger UI instance / Open API 3.0.3 Spec
- TypeORM (over a Postgresql DB)
- Jest (Unit Testing)
- Docker + Heroku (How and where we are running our app for free)
- Github Actions (CI/CD tool)
See Ts.ED project for more information.
This API has the following features:
- Car:
- CRUD operations
- List cars by color and brand
- Driver:
- CRUD operations
- List drivers by name
- Rental:
- Enable a driver to start renting car.
- Enable a driver to stop renting car.
- List all renting data.
Important! Ts.ED requires Node >= 10, Express >= 4 and TypeScript >= 3.
# install dependencies
$ npm run i
# For Development
$ npm run dev
# For Production
$ npm run build
$ npm run start
You can also use docker-compose up
to run our app! Don't forget to overwrite the .env
file.
# Docker Compose
$ docker-compose up