Truck API

Restfull API for Truck and Truck Position registration using Node

How to execute this project

Node version: v12.16.1

Yarn Version: 1.22.0

Database: MariaDB 10.4.6-MariaD

Create a database with name truck-api

Configure your database credentials on file: /.env

Install the dependencies

yarn install

Create the tables on database

yarn sequelize db:migrate

Run the application with the command

yarn dev

Run the tests with the command

yarn test

Import the Requests on Insomnia

You can use the Insomnia (https://insomnia.rest/) to make the calls to the API endpoints. Install Insomnia and import the file Insomnia_2020-03-01.json.

API Documentation

The documentation of the API can be accessed with the follow link, while the application is running. http://localhost:3333/api-docs