README.md

Project Car Shop

API was developed using TypeScript following the principles of Programming Oriented Object (POO), Behavior Driven Development (BDD) and using ODM Mongoose to perform the CRUD of a vehicle carrier.

Unit tests were also developed for all layers and integration tests to validate the operation of the API.

Running locally

Clone the project

  git clone git@github.com:lucas-da-silva/car-shop.git

Enter the project directory

  cd project-car-shop

Upload containers (docker-compose is required)

  docker-compose up -d

Enter the car_shop container

  docker exec -it car_shop bash

Install the dependencies

  npm install

Start the server

  npm run dev

Running the tests

Inside the car_shop container, run the following command

  npm run test

API documentation

Register a new car

  POST /cars

Request body parameters:

Parameter	Type	Description
model	string	Mandatory. Vehicle model
year	number	Mandatory. Year of manufacture of the vehicle
color	string	Mandatory. Vehicle main color
status	boolean	Optional. Vehicle may or may not be purchased
buyValue	number	Mandatory. Vehicle purchase price
doorsQty	number	Mandatory. Number of doors on a car
seatsQty	number	Mandatory. Number of seats in a car

List all cars

  GET /cars

List a car

  GET /cars/${id}

Parameter	Type	Description
id	string	Mandatory. ID of the car you want

Update a car

  PUT /cars/${id}

Parameter	Type	Description
id	string	Mandatory. Car ID you want to change

Request body parameters:

Parameter	Type	Description
model	string	Mandatory. Vehicle model
year	number	Mandatory. Year of manufacture of the vehicle
color	string	Mandatory. Vehicle main color
status	boolean	Optional. Vehicle may or may not be purchased
buyValue	number	Mandatory. Vehicle purchase price
doorsQty	number	Mandatory. Number of doors on a car
seatsQty	number	Mandatory. Number of seats in a car

Delete a car

  DELETE /cars/${id}

Parameter	Type	Description
id	string	Mandatory. Car ID you want to delete

Register a new motorcycle

  POST /motorcycles

Request body parameters:

Parameter	Type	Description
model	string	Mandatory. Vehicle model
year	number	Mandatory. Year of manufacture of the vehicle
color	string	Mandatory. Vehicle main color
status	boolean	Optional. Vehicle may or may not be purchased
buyValue	number	Mandatory. Vehicle purchase price
category	number	Mandatory. Motorcycle category (options: Street, Custom or Trail)
engineCapacity	number	Mandatory. Engine capacity

List all motorcycles

  GET /motorcycles

List a motorcycles

  GET /motorcycles/${id}

Parameter	Type	Description
id	string	Mandatory. ID of the motorcycles you want

Update a motorcycle

  PUT /motorcycle/${id}

Parameter	Type	Description
id	string	Mandatory. Motorcycle ID you want to change

Request body parameters:

Parameter	Type	Description
model	string	Mandatory. Vehicle model
year	number	Mandatory. Year of manufacture of the vehicle
color	string	Mandatory. Vehicle main color
status	boolean	Optional. Vehicle may or may not be purchased
buyValue	number	Mandatory. Vehicle purchase price
category	number	Mandatory. Motorcycle category (options: Street, Custom or Trail)
engineCapacity	number	Mandatory. Engine capacity

Delete a motorcycle

  DELETE /motorcycle/${id}

Parameter	Type	Description
id	string	Mandatory. Motorcycle ID you want to delete

Stack used

Database: MongoDB

Back-end: TypeScript, Express, Mongoose, Jest, Chai, Sinon