speedy

Project developed for the Rocketseat Ignite (Node.js Path). This application is a simple REST API and It was built to manage package deliveries.

🌍 Ecosystem

Below the technologies, used to build this API:

Name	Status

🧱 ERM

▶️ Getting started

Requirements

• Node.js
• PostgreSQL Container

Clone the project

$ git clone https://github.com/wladimirgrf/speedy.git && cd speedy

Install the Project dependencies

$ npm install

Environment configuration

# Make a copy of '.env.sample'
# Fill it with your environment variables
$ cp .env.sample .env

Run the container

# Create the instance of postgreSQL using docker
$ docker run --name postgres -e POSTGRES_PASSWORD={password} -p 5432:5432 -d postgres

Migrations

$ npx prisma migrate dev

Launch the Application

$ npm start

The API will be launch at localhost on the chosen port or on the default 3333

🤝 Contributing

Fork the repository and clone your fork

$ git clone fork-url && cd speedy

Create a branch for your edits

$ git checkout -b new-feature

Make the commit with your changes

$ git commit -m 'feat: New feature'

Send the code to your remote branch

$ git push origin new-feature

Create a pull request with your version.
After your pull request is merged, you can delete your branch.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.