README.md

Trybe Futebol Cube (Soccer Club) ⚽

This Project shows a leaderboard of all soccer teams in a competition, and lets you add teams, matches, and scores.

First commit: on Sep 27, 2022.

Here I had to exercise: POO, TDD, Node.js, Express, Typescript, Sequelize, mySQL, docker.

This is a full-stack JavaScript Project, but the front-end came already coded by the school Trybe.

How to run it:

You need to have installed:

- Unix based Operational System
- node version >= 16.14.0 LTS
- Docker
- Docker-compose version >= 1.29.2

command: npm install
Use Docker, command: npm run compose:up

Open front-end on http://localhost:3000/login

login info:

• login: admin@admin.com
• senha(password): secret_admin

Files/Folders Ownership

Here you find a list of files and or folders according to the ownership.

🙋‍♀️ I coded myself:

app/
  backend/
    src/ 
      controllers/
      database/
        migrations/ (except 99999999999999-create-z.js)
        Models/ (except ExampleModel.ts & index.ts)
      helpers/
      interfaces/
      middlewares/ (except error.middleware.ts)
      routes/
      services/
      tests/
    Dockerfile
  frontend/
    Dockerfile
    packages.npm
README.md

🧑‍🤝‍🧑 I coded partially - the scholl has coded some of it:

 app/
   backend/
     src/
       app.ts

🧛 coded by a teacher or a teammate:

 app/
   backend/
     helpers/
       BcryptService.ts -> ref. school class code
     middlewares/
       error.middleware.ts -> ref. school classes material and project revision class code

🏫 coded by the school:

 all others not mentioned before.

✨ all icons used here are from: EmojiPedia.

🚧 README under construction 🚧