/hard-braking-zones-socket

Server-side application responsible for receiving and saving the user's speed and position. Project that is part of a scientific initiation at Facens in the period 2021/2022.

Primary LanguageTypeScript

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

The project consists of an app capable of recording the speed and position of the user 24 hours a day, in order to find, through an AI, hard braking zones in the city.

Written with Typescript this application is responsible for saving the user's speed and location data.

Getting started

First you must to clone the repository using:

$ git clone 'https://github.com/caiquetorres/hard-braking-zones-socket.git'

After that install all the required dependencies with:

$ yarn global add @nestjs/cli

$ yarn add

This project uses husky's commit-msg hook. For using it run the following commands:

$ npx husky install

$ npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

Running the app

# development
$ nest start

# watch mode
$ nest start --watch

# production mode
$ nest start --prod

Docker

The application uses Docker for running some examples of databases.

Obs: Using the ".env.{database}.example" files you can copy the configuration found in them and place it in the ".env" file.

For using InfluxDB

$ sudo docker-compose up -d influxdb

Sentry

The app is also integrated with Sentry, allowing you to track exceptions and store them.

License

Hard Braking Zones API is MIT licensed.