Skip to content

Jacoappolinario/Boatme

Repository files navigation

Boatme

Boate is a boat rental company, which will operate throughout Brazil, with vessels in several locations, aiming to make the rental process quick and practical and within reach of everyone.

🚀️ Features

  • 🛥️ Boats CRUD
  • 📑️ Categories CRUD
  • 🕹️ Specifications CRUD
  • 🙋🏾️ User CRUD
  • 📸️ Upload User Avatar
  • 🔐️ User Authentication
  • 📱️ Mobile User Authentication
  • ✍️ Rentals Boats
  • 📃️ List Rentals By User
  • 📂 Import categories from CSV files

👷🏾‍♂️️ Installation

You need to install Node.js and Yarn and Docker first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/Jacoappolinario/Boatme.git

Install dependencies

yarn install

Create your enviroment variables based on the examples of .env.example

cp .env.example .env

After copying the examples, make sure to fill the variables with new values. For Twilio credentials, register on the Platform by clicking here here, and after registering, create a service in the Verify API.

Run docker container

docker-compose up -d

🏃🏾‍♂️️ Getting Started

Run the transactions in order to configure the database schema

yarn typeorm migration:run

Run admin seed

yarn seed:admin

Viewing application logs

docker logs boatme -f

👨🏾‍🔬️ Running Tests

To run tests, run the following command

yarn test

📮️ Faq

Question: What are the tecnologies used in this project?

Answer: The tecnologies used in this project are NodeJS + Express Framework to handle the server and TypeORM as a communication service with the database. In addition to these technologies, Jest was used to develop integration tests and unit tests.

Author

👤 Jacó Apolinário

Show your support

Give a ⭐️ if this project helped you!

About

🛥️ Boatme is a boat rental API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages