README.md

🚧 readme in construction 🚧

Trybe Futebol Club

Status: finished ✔️ ⚠️

⚠️ Extra:

• TS + React
• Unit tests

Project done individually during the course of the Trybe.

TFC is an informative website about soccer matches and standings! ⚽

👩‍💻 Technologies

• Software Architecture (MSC - Model, Service and Controller)
• Node.js, SOLID and DDD
• React.js, TypeScript
• Express.js, MySQL, Sequelize

👩‍💻 To Run and Test

Before anything, you'll need to run npm run build in your terminal (inside the back-end file), to build the application.

• Database: It will be a MySQL docker container already configured in docker-compose via a service defined as db. It has the role of providing data to the backend service. You can also connect to a MySQL Client (Workbench, Beekeeper, DBeaver and etc) by putting the credentials configured in docker-compose into the db service.

  Here's the entities diagram

  
  

• Back-end:

• Front-end: It access the site http://localhost:3000/; connect with the back-end by http://localhost:3001;

👉 Running with Docker (⚠️ docker-compose 1.29 or superior)

...

👉 Running locally (without Docker)

...

And it should look like this!

---

Copyright copyright Trybe 2022 - Full-Stack Project Trybe Futebol Club
Performed according to the guidelines of the Trybe's Code of Conduct and Student Person Handbook.