tharlei/wet-bat-travel

MVP dashboard

Summary

🔹 Description

🔹 Functions

🔹 Deploy

🔹 Documentation

🔹 Requirements

🔹 Execute the application

🔹 Technologies used

🔹 Structure decisions

🔹 Author

🔹 License

Description

MVP of Wet Bat Travel functions to create quotes

Functions

✔️ List transports

✔️ Store quote

Deploy

Application: https://wet-bat-travel.netlify.app/

Documentation

Documentation in Postman: https://documenter.getpostman.com/view/4827382/Uz5JFaEb

Requirements

⚠️ Node:^16

⚠️ PostgreSQL or MySQL (recommended)

Execute the application

In the terminal, clone project:

git clone https://github.com/tharlei/wet-bat-travel.git

Enter in folder

cd wet-bat-travel

Install npm dependencies:

npm i && npm i --prefix server/

Copy .env.example to .env and fill with your data:

cp .env.example .env && cp server/.env.example server/.env

Run migrations:

npm run typeorm --prefix server/ -- migration:run

Run tests of the project:

npm run test

Run development mode project:

npm run dev

Technologies used

• Clean Architecture
• Typescript
• React
• Vitest
• Vite
• date-fns
• Cogo Toast
• Node.js
• Express
• TailwindCSS

Structure decisions

• Folder "infra" has classes that are externally dependent on something. (library, route, bank connection)
• Folder "repository" is responsible for handling database data.
• Folder "queries" is intended to return data already mapped from the database.
• Folder "services" it aims to execute some logic before sending to external dependency.

Author

_{Tharlei Aleixo}

License

The MIT License (MIT)

Copyright ©️ 2022 - wet-bat-travel