/gratibox-api

API designed for GratiBox app

Primary LanguageJavaScript

☯️ GratiBox API

Receive at home a box with teas, organic products, incense and much more...

Status: Finished

About • Database Layout • How it works • Pre-requisites • Tech Stack • How to contribute • Author

About

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.

Database Layout

Database Layout

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

How it works

This project is divided into two parts:

  1. Backend (This repository)
  2. Frontend (You can find here: https://github.com/okitauehara/gratibox)

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, VSCode.

Running the Backend (server)

// 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

Tech Stack

The following tools were used in the construction of the project-api:

Server (NodeJS)

See the file package.json

Utilitários

How to contribute

  1. Fork the project.
  2. Create a new branch with your changes: git checkout -b feat/myFeatureName
  3. For each feature implemented, make a commit specifying what was done
  4. Submit your changes: git push -u origin feat/myFeatureName

Author

Developed by Marcos Okita Uehara.