🚧 Under development 🚧

Table of contents

• Prerequisites
• How to run the application
  • Backend setup & start
  • Frontend setup & start
• Tecnologies
• Author
• Features

Prerequisites

Before starting, you're gonna nedd to have Docker installed on your machine. Besides that, a text editor like VSCode is recommended.

How to run the application

Backend setup & start

1. Create a file .env
2. Copy what is inside .env.example and paste in .env
3. Change the necessary fields in .env (setup Mailtrap)
4. Open the terminal at the backend folder and type the command bellow to install the required packages:

   > yarn

5. Open the terminal at the backend folder and type the command bellow to build the backend and database containers:

   > docker-compose up --build -d

6. Run all the migrations:

   > docker exec devschools_backend yarn typeorm migration:run

7. Watch the backend logs:

   > docker logs -f devschools_backend

Frontend setup & start

1. Open the terminal at the frontend folder and type the command bellow to install the required packages:

   > yarn

2. In frontend folder, type the command bellow:

   > yarn start

Tecnologies

• Node.js
• React
• TypeScript
• PostgreSQL
• Docker

Author

Made by Daniel Gustavo