About the Project
- Built With
Getting Started
- Prerequisites
- Installation
  - Docker
  - FastFeet
  - Back-end
  - Front-end
License
Contributing
Contact
Acknowledgements

💥 About The Project

Description

"Fastfeet" it's a challenge created by Rocketseat for its students to create the whole application from scratch to fully working software. The idea is to use the skills learned in the GoStack Bootcamp, with the technologies Node.js, React and React Native.

The software is a fictitious transporter app and it has the following features:

deliveryman, order, and recipients (create, edit, delete)
deliveryman receive an email when an order is created or canceled
each deliveryman can only do 5 deliveries per day
file upload
Pickup and deliveries confirmation
Pickups are allowed between 08h and 18h

More details

⚙️ Built With

🚀 Getting Started

To get a local copy up and running follow these simple steps.

📋 Prerequisites

Node.js - Install guide
Yarn - Install guide
Docker - Install guide

⬆️ Back to top

⚡ Installation

Docker Installation

Run the commands below to create the required containers

#Create a Postgres container with a fastfeet database
docker run --name pg_fastfeet -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=fastfeet -p 5432:5432 -d postgres

#Create a Redis container
docker run --name rds_fastfeet -p 6379:6379 -d -t redis:alpine

⬆️ Back to top

FastFeet Installation

Clone the rs_bc_fastfeet

git clone https://github.com/jvitormf/rs_bc_fastfeet.git

⬆️ Back to top

Back-end Installation

Navigate to the backend folder and run the command below to install the required packages
```
yarn
```
In the backend folder, create a .env file with the .env.example and fill it with the required variables, (APP_SECRET and Mail variables)
- You can use Mailtrap to get the info for the Mail variables
Run the commands below to create the database tables.
```
  yarn sequelize db:migrate
```
Run the commands below to populate the database tables.
```
  yarn sequelize db:seed:all
```
To sign in, use [email protected] email and password 123456
And finally to let the API up and running
```
  yarn dev
```
Open another terminal and run the command yarn queue to start the mail process.

⬆️ Back to top

Front-end Installation

Navigate to the frontend folder and run the command below to install the required packages
```
yarn
```
To let the Frontend up and running
```
yarn start
```

⬆️ Back to top