Gratibox API 😊

This is the backend repo, access the frontend repo here.

View the deploy

About

A simple but wonderful application for you to express your gratitude. Subscribe and receive at home wonderful products to keep yourself grateful.

Technologies

Tools that were used in the project:

Getting Started

To run locally follow the steps

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Create the root folder named gratibox and access it

mkdir gratibox && cd gratibox

2. Clone the frontend repo

git clone https://github.com/cgabrieu/gratibox-frontend.git

3. Install dependencies with npm

npm install

4. Clone the backend repo

git clone https://github.com/cgabrieu/gratibox-backend.git

5. Install dependencies with npm

npm install

6. Create a database using the command below via postgres

CREATE DATABASE gratibox;

7. Automatically create all necessary tables to backend repo with dump.

8. Connect your backend to the database, for that, rename the .env.example to .env.dev and fill in your data.

How to run

1. Run the frontend using the command (remember to be on the backend repo):

npm run start:dev

2. Run the frontend using the command (remember to be on the fronend repo):

npm start

Developer

• Carlos Gabriel