{"id":21290002,"url":"https://github.com/guilhermecampellof/tfc-backend","last_synced_at":"2026-05-22T14:12:51.045Z","repository":{"id":249286392,"uuid":"830727273","full_name":"GuilhermeCampelloF/tfc-backend","owner":"GuilhermeCampelloF","description":"Back-end dockerizado desenvolvido para um site informativo sobre partidas e classificações de futebol. Projeto desenvolvido durante o curso de formação Full-Stack da Trybe.","archived":false,"fork":false,"pushed_at":"2024-07-19T21:49:56.000Z","size":680,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T06:11:40.325Z","etag":null,"topics":["dockerfile","javascript","jwt","sequelize","typescript"],"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/GuilhermeCampelloF.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":"2024-07-18T21:30:29.000Z","updated_at":"2024-07-19T21:49:59.000Z","dependencies_parsed_at":"2024-07-19T22:03:06.450Z","dependency_job_id":"dc4402c7-2d6a-4320-93a9-3af7a265cd91","html_url":"https://github.com/GuilhermeCampelloF/tfc-backend","commit_stats":null,"previous_names":["guilhermecampellof/tfc-backend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCampelloF%2Ftfc-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCampelloF%2Ftfc-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCampelloF%2Ftfc-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCampelloF%2Ftfc-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GuilhermeCampelloF","download_url":"https://codeload.github.com/GuilhermeCampelloF/tfc-backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243754094,"owners_count":20342542,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["dockerfile","javascript","jwt","sequelize","typescript"],"created_at":"2024-11-21T12:44:20.509Z","updated_at":"2026-05-22T14:12:41.031Z","avatar_url":"https://github.com/GuilhermeCampelloF.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## TRYBE FUTEBOL CLUBE\n\nO projeto Trybe Futebol Clube (TFC) foi desenvolvido durante o curso de formação full-stack pela Trybe.\n\nA aplicação consiste em um site informativo sobre partidas e classificações de futebol! ⚽️\n\nNesse projeto, foi construído um back-end dockerizado utilizando modelagem de dados através do Sequelize, respeitando as regras de negócio para que a API fosse capaz de ser consumida adequadamente por um front-end previamente implementado.\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e🗄️ ESTRUTURA DO PROJETO 🗄️\u003c/strong\u003e\u003c/summary\u003e\u003cbr /\u003e\n\nO projeto é composto de 4 entidades importantes para sua estrutura:\n\n1️⃣ **Banco de dados:**\n  - Container docker MySQL já configurado no docker-compose através de um serviço definido como `db`;\n  - Tem o papel de fornecer dados para o serviço de _backend_;\n\n2️⃣ **Back-end:**\n - Roda na porta `3001`, pois o front-end faz requisições para ele nessa porta por padrão;\n\n3️⃣ **Front-end:**\n  - Acessado pela url `http://localhost:3000` através dos endpoints construídos;\n\n4️⃣ **Docker:**\n  - O `docker-compose` tem a responsabilidade de unir todos os serviços conteinerizados (backend, frontend e db) e subir o projeto completo com o comando `npm run compose:up`;\n\nA modelagem do banco de dados respeita o seguinte diagrama de entidade-relacionamento:\n\n![diagrama-er](https://github.com/user-attachments/assets/34fee149-f567-47fa-a52c-69dbb7872a39)\n\n\u003c/details\u003e\n\n## REQUISITOS\n\n- Node.js\n- Docker/Docker compose\n\nApós clonar o repositório, é necessário realizar a instalação das depedências gerais na pasta raiz do projeto, através do comando:\n\n```shell\nnpm install\n```\n\nAinda na raiz do projeto, também é necessário realizar a instalação das dependências próprias dos diretórios _frontend_ e _backend_, com o comando:\n\n```shell\nnpm run install:apps\n```\n\nRealizadas essas etapas, será possível executar/encerrar o projeto completo utilizando os scripts de apoio `npm run compose:up` e `npm run compose:down`, respectivamente.\n\nO front-end da aplicação pode ser acessado pela url `http://localhost:3000`.\n\n## 📖 HABILIDADES TRABALHADAS 📖\n\n- Desenvolvimento de API utilizando o método TDD;\n- Integração do projeto através do docker compose;\n- Modelagem de dados através do Sequelize;\n- Autenticação via JWT;\n\n## IMPLEMENTAÇÕES REALIZADAS\n\n- Migrations, models, interfaces, services e controllers necessários para o correto funcionamento do back-end (é possível conferir todas as implementações pelo histórico de commits do projeto)\n\n## ©️ DISCLAIMER\n\n\u003cdiv align=\"justify\"\u003e\nCom exceção das alterações destacadas acima no tópico \"implementações realizadas\", \u003cb\u003eTODOS OS DEMAIS ARQUIVOS\u003c/b\u003e foram desenvolvidos e estão sob responsabilidade da TRYBE, incluindo, mas não se limitando ao: front-end pré-implementado, diagrama entidade-relacionamento do sistema, seeders e organização dos demais diretórios da aplicação.\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguilhermecampellof%2Ftfc-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguilhermecampellof%2Ftfc-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguilhermecampellof%2Ftfc-backend/lists"}