filipebteixeira98/delivery-api

DeliveryAPI - An order delivery service

About the project • Technologies • Getting started • License

📚 About the project

DeliveryAPI is a project created in Rocketseat Ignite Node.js bonus training.

This small server application was developed in order to study the main concepts of Prisma ORM. In a simple way, it allows registering an account for clients either deliverymen, place orders, in addition to providing some information about it and much more.

🚀 Technologies

This project was made using the follow technologies:

💻 Getting started

Requirements

Node.js
Yarn or NPM (examples are with yarn)
One instance of PostgreSQL

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/filipebteixeira98/delivery-api.git

Follow the steps below

# Create the instance of postgreSQL using docker
docker run --name delivery-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=delivery -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Install Dependencies
$ yarn

# Use the script to run the migrations
$ yarn prisma migrate dev

# Run Application
$ yarn dev

🐛 Issues

Create a new issue report, it will be an honor to be able to help you solve and further improve our application.

✨ Contributing

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork filipebteixeira98/delivery-api

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd delivery-api

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

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.

Made with 💜 by Filipe Teixeira

Thank you! 🌠

filipebteixeira98 / delivery-api