{"id":21862103,"url":"https://github.com/igorbrizack/tfc-project-api","last_synced_at":"2026-04-08T18:32:01.324Z","repository":{"id":115372980,"uuid":"557970770","full_name":"IgorBrizack/TFC-Project-API","owner":"IgorBrizack","description":"O TFC é um site de informativo de partidas de Futebol, onde pode-se observar as classificações dos times.","archived":false,"fork":false,"pushed_at":"2022-10-26T17:19:33.000Z","size":706,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-21T20:22:43.988Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IgorBrizack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-26T16:41:47.000Z","updated_at":"2023-03-22T18:32:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"d43db7fd-f313-4edf-a620-8e49a5ce83ca","html_url":"https://github.com/IgorBrizack/TFC-Project-API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/IgorBrizack/TFC-Project-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgorBrizack%2FTFC-Project-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgorBrizack%2FTFC-Project-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgorBrizack%2FTFC-Project-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgorBrizack%2FTFC-Project-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IgorBrizack","download_url":"https://codeload.github.com/IgorBrizack/TFC-Project-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgorBrizack%2FTFC-Project-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31568620,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-28T03:13:49.836Z","updated_at":"2026-04-08T18:32:01.297Z","avatar_url":"https://github.com/IgorBrizack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# ⚽ Trybe Futebol Clube\n\nO TFC é um site informativo sobre partidas e classificações de futebol!\n\n![tfc](https://user-images.githubusercontent.com/99822908/197893222-e9b8bf64-e6cb-415d-b273-ff045ff426cd.png)\n\n\n## 📋 Execute o projeto em sua máquina\n\nClone o repositório:\n\n```\ngit clone git@github.com:IgorBrizack/TFC-Project-API.git\ncd trybe-futebol-clube\nnpm install\n```\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e ⚠️ Configurações mínimas para execução do projeto\u003c/strong\u003e\u003c/summary\u003e\u003cbr /\u003e\n\nNa sua máquina você deve ter:\n\n - Sistema Operacional Distribuição Unix\n - Node versão 16\n - Docker\n - Docker-compose versão \u003e=1.29.2\n\n➡️ O `node` deve ter versão igual ou superior à `16.14.0 LTS`:\n  - Para instalar o nvm, [acesse esse link](https://github.com/nvm-sh/nvm#installing-and-updating);\n  - Rode os comandos abaixo para instalar a versão correta de `node` e usá-la:\n    - `nvm install 16.14 --lts`\n    - `nvm use 16.14`\n    - `nvm alias default 16.14`\n\n➡️ O`docker-compose` deve ter versão igual ou superior à`ˆ1.29.2`:\n  * Use esse [link de referência para realizar a instalação corretamente no ubuntu](https://app.betrybe.com/learn/course/5e938f69-6e32-43b3-9685-c936530fd326/module/94d0e996-1827-4fbc-bc24-c99fb592925b/section/5987fa2d-0d04-45b2-9d91-1c2ffce09862/day/2f1a5c4d-74b1-488a-8d9b-408682c93724/lesson/b883b81d-21f6-4b60-aa62-8508f6017ea0);\n  * Acesse o [link da documentação oficial com passos para desinstalar](https://docs.docker.com/compose/install/#uninstallation) caso necessário.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003e🐋 Rodando no Docker\u003c/strong\u003e\u003c/summary\u003e\n  \n  \u003cbr/\u003e\n\n  \u003e :information_source: Rode os serviços com o comando `docker-compose up -d --build`.\n\n\u003c/details\u003e\n\n## 🔎 Documentação da API\n\n\n## Documentação da API\n\n#### Login\n\n```\n  POST /login \n```\n\n| Parâmetro   | Tipo       | Descrição                           |\n| :---------- | :--------- | :---------------------------------- |\n| `email` | `string` | **Obrigatório**. Seu email. |\n| `password` | `string` | **Obrigatório**. Sua senha. |\n\n#### Validação de Login\n\n```\n  GET /login/validate\n```\n\n| Parâmetro   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `Authorization`      | `string` | **Obrigatório**. Token do login deve ser passado no header. |\n\n#### Times\n\n```\n  GET /teams\n```\n\n```\n  GET /teams/:id\n```\n\n| Parâmetro   | Tipo       | Descrição                           |\n| :---------- | :--------- | :---------------------------------- |\n| `id` | `string` | **Obrigatório**. Id do time deve ser passado pelo parâmetro da URL. |\n\n#### Partidas\n\n```\n  GET /matches\n```\n\n```\n  GET /matches?inProgress=true\n```\n\n```\n  GET /matches?inProgress=false\n```\n\n```\n  POST /matches\n```\n| Parâmetro   | Tipo       | Descrição                           |\n| :---------- | :--------- | :---------------------------------- |\n| `homeTeam` | `number` | **Obrigatório**. Id do time da casa. |\n| `awayTeam` | `number` | **Obrigatório**. Id do time visitante. |\n| `homeTeamGoals` | `number` | **Obrigatório**. Número de gols do time da casa. |\n| `awayTeamGoals` | `number` | **Obrigatório**. Número de gols do time visitante. |\n| `Authorization`      | `string` | **Obrigatório**. Token do login deve ser passado no header. |\n\n```\n  PATCH /matches/:id/finish\n```\n| Parâmetro   | Tipo       | Descrição                           |\n| :---------- | :--------- | :---------------------------------- |\n| `id` | `string` | **Obrigatório**. Id da partida deve ser passada pelo parâmetro da URL. |\n\n```\n  PATCH /matches/:id/\n```\n| Parâmetro   | Tipo       | Descrição                           |\n| :---------- | :--------- | :---------------------------------- |\n| `id` | `string` | **Obrigatório**. Id da partida deve ser passada pelo parâmetro da URL. |\n| `homeTeamGoals` | `number` | **Obrigatório**. Número de gols do time da casa. |\n| `awayTeamGoals` | `number` | **Obrigatório**. Número de gols do time visitante. |\n\n#### Tabela de Classificação\n\n```\n  GET /leaderboard/home\n```\n\n```\n  GET /leaderboard/away\n```\n\n```\n  GET /leaderboard\n```\n\n## 👨🏻‍💻 Habilidades\n\n- Realização da dockerização dos apps, network, volume e compose;\n- Modelagem de dados com MySQL através do Sequelize;\n- Criação e associação de tabelas usando models do sequelize;\n- Construção de uma API REST com endpoints para consumir os models criados;\n- Construção de um CRUD com TypeScript, utilizando ORM;\n- Validar dados das requisições com a biblioteca Joi.\n- Implementar testes de integração com Mocha, Chai e Sinon.\n\n## 🧪 Executando os testes\n\nEntre na pasta do backend ```cd app/backend```\n\n```\nnpm run test\n\n```\n![TESTES1](https://user-images.githubusercontent.com/99991795/198088494-bb976c66-0881-45ec-b27a-31a92d6854ee.png)\n\nTestes de cobertura:\n\n```\nnpm run test:coverage\n```\n\n![TESTES2](https://user-images.githubusercontent.com/99991795/198088653-396ed50c-791e-4312-983e-140d623a3169.png)\n\n\n## 🛠️ Ferramentas \u0026 Metodologias Utilizadas\n\n- [Node.js](https://nodejs.org/en/);\n- [Express.js](https://expressjs.com/);\n- [MySQL](https://www.mysql.com/);\n- [mysql2](https://www.npmjs.com/package/mysql2);\n- [Sequelize(ORM)](https://sequelize.org/);\n- [JWT(Autenticação)](https://jwt.io/);\n- [Joi](https://joi.dev/api/?v=17.6.0);\n- [Docker](https://www.docker.com/);\n- [TypeScript](https://www.typescriptlang.org/);\n- [Mocha](https://mochajs.org/);\n- [Chai](https://www.chaijs.com/);\n- [Sinon.js](https://sinonjs.org/);\n\n---\n⌨️ desenvolvido por [Igor Brizack](https://www.linkedin.com/in/igor-brizack/) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorbrizack%2Ftfc-project-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figorbrizack%2Ftfc-project-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorbrizack%2Ftfc-project-api/lists"}