☯️ GratiBox API
About • Database Layout • How it works • Pre-requisites • Tech Stack • How to contribute • Author
Aiming to encourage a healthier lifestyle, GratiBox is a startup that delivers box with healthy and #gratitude products. Customers can choose between two recurring subscription plans, weekly or monthly. Each box contains assorted products such as teas, organic products, incense sticks. Customers cannot choose the products and do not know what will be sent in each box.
The database was designed at https://www.dbdesigner.net/ for PostgreSQL.
/* In your psql terminal */
CREATE DATABASE gratibox;
/* Access the database */
\c gratibox
Now, just run the commands listed in dump.sql
This project is divided into two parts:
- Backend (This repository)
- Frontend (You can find here: https://github.com/okitauehara/gratibox)
Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, VSCode.
// Clone this repository
$ git clone git@github.com:okitauehara/gratibox-api.git
// Access the project folder cmd/terminal
$ cd gratibox-api
// Install the dependencies
$ npm install
// Create a .env.dev file and fill it using your environment variables following the .env.example
// Run the application in development mode
$ ntl -> start:dev
// The server will start at port: 4000
You can find the .env.example here
The following tools were used in the construction of the project-api:
Server (NodeJS)
See the file package.json
Utilitários
- API: Brasil API
- Editor: Visual Studio Code
- API Test: Insomnia, Thunder Client
- Fork the project.
- Create a new branch with your changes:
git checkout -b feat/myFeatureName
- For each feature implemented, make a commit specifying what was done
- Submit your changes:
git push -u origin feat/myFeatureName
Developed by Marcos Okita Uehara.