Logo

Gratibox

Helping you to be more grateful!
Explore the docs »
View Demo

Technologies

The following tools and frameworks were used in the construction of the project:

Getting Started

To get a local copy up and running follow these simple 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 a root project folder named gratibox for semantics
mkdir gratibox
  1. Clone the front-end repo (within the /gratibox folder)
git clone https://github.com/leandrodcs/gratibox-front.git
  1. Install NPM packages for the front-end repo
npm install
  1. Clone the back-end repo (within the /gratibox folder)
git clone https://github.com/leandrodcs/gratibox-back.git
  1. Install NPM packages for the back-end repo
npm install
  1. Create a database using the command below via postgres
CREATE DATABASE gratibox
  1. Inside the created database, create tables using the dump included in the back-end repo here.

  2. Connect to the created database using the .env.example included in the back-end repo here, to make it easy, name your .env file like so ".env.dev".

Running

  1. On the back-end repo run the server connected to the database you just created using the following command.
npm run dev
  1. Now on the fron-end repo use the same command you just used on step 8 and you should be good.

Usage

Visitors can Subscribe to two different plans, being them monthly or weekly.

Both plans can provide you with three different kinds of products, being them: teas, organic products and incense. You are free to choose the one you want or even all of them.

The monthly subscription will give you one box per month, the weekly subscription will give you one box per week.

When you become a subscriber, the Homepage will provide you with all your subscription data, including your next three delivery dates, according to the date you chose while subscribing.

Developer