{"id":21967430,"url":"https://github.com/cayo-rodrigues/yoca","last_synced_at":"2025-04-24T05:33:33.593Z","repository":{"id":37299524,"uuid":"492865141","full_name":"cayo-rodrigues/yoca","owner":"cayo-rodrigues","description":"Uma api com o objetivo de gerenciar os processos envolvidos na administração de um restaurante, com controle de estoque semi-automático.","archived":false,"fork":false,"pushed_at":"2022-11-07T11:40:53.000Z","size":2139,"stargazers_count":2,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T07:22:31.567Z","etag":null,"topics":["api","api-rest","docker","docker-compose","express","jest","nodejs","postgresql","sql","typeorm","typescript"],"latest_commit_sha":null,"homepage":"https://cayoca.up.railway.app/","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/cayo-rodrigues.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}},"created_at":"2022-05-16T14:13:55.000Z","updated_at":"2022-11-28T17:05:20.000Z","dependencies_parsed_at":"2023-01-21T07:15:21.459Z","dependency_job_id":null,"html_url":"https://github.com/cayo-rodrigues/yoca","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cayo-rodrigues%2Fyoca","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cayo-rodrigues%2Fyoca/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cayo-rodrigues%2Fyoca/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cayo-rodrigues%2Fyoca/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cayo-rodrigues","download_url":"https://codeload.github.com/cayo-rodrigues/yoca/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250572639,"owners_count":21452334,"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":["api","api-rest","docker","docker-compose","express","jest","nodejs","postgresql","sql","typeorm","typescript"],"created_at":"2024-11-29T13:27:21.665Z","updated_at":"2025-04-24T05:33:33.568Z","avatar_url":"https://github.com/cayo-rodrigues.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yoca - Gerenciador de Restaurantes\n\n**URL base da API** -\u003e https://cayoca.up.railway.app\n\n## Sobre o projeto\n\nRestaurantes enfrentam muitas demandas e precisam administrar/gerenciar seus produtos e funcionários todos os dias, para tornar todos esses processos mais simples e centralizar suas informações desenvolvemos um sistema de administração com objetivo de gerenciar pedidos, funcionários e estoque.\nCom o Yoca você pode cadastrar seus funcionários, cadastrar novos produtos com suas respectivas informações, assim como cadastrar novos ingredientes e administrar o estoque desses ingredientes, além de registrar novos pedidos assim como editar seus respectivos status e relacioná-los com uma comanda para pagamento por parte do cliente. Também temos um endpoint para caso o cliente queira deixar um feedback sobre o restaurante ou sobre um produto em específico.\n\n**Link para a documentação** -\u003e https://cayoca.up.railway.app/api/docs\n\nArquivo `json` para usar no **insomnia** -\u003e [Clique aqui](https://drive.google.com/file/d/1FB88eVzbDHfkmrzHgcJbIEoOqEf_M9N5/view)\n\n## Rodando o projeto\n\nPara rodar o projeto em ambiente de desenvolvimento basta que você configure suas variáveis de ambiente (.env) e execute o comando `docker-compose up --build`, assim ele irá criar a imagem e os bancos, de desenvolvimento e de testes, e irá estabelecer as conexões. Após isso basta utilizar os endpoints na url http://localhost:3000.\n\n\u003cimg src=\"./assets/Yoca-app-running.png\" alt=\"Yoca app running\"/\u003e\n\n## Testes\n\nToda a aplicação conta com testes de integração que cobrem todas as principais rotas a serem usadas na API, para isso utilizamos o Jest juntamente com o Supertest. O banco de dados que armazena os dados criados a cada teste é gerado em um ambiente docker, para isso utilizamos o docker-compose, com um arquivo .yml.\n\n## Rodando os testes\n\nComo temos muitos testes de integração devido a quantidade de rotas, além de prezar pelo desempenho, tanto dos testes quanto da sua máquina, vamos instalar o jest globalmente para conseguirmos rodar os testes individualmente, assim conseguimos evitar problemas nos testes e em máquinas menos potentes.\nPara começar rode `yarn global add jest` ou `npm install -g jest` em sua cli. Após isso vamos definir a variável que será o seu database de testes, preencha-a no seu .env com o valor desejado, além das credenciais que serão usadas na sua conexão com o postgres. Agora execute `docker-compose up --build` e aguarde o database ser criado. Logo após o database ser criado já podemos executar nossos testes! Então rode `yarn jest caminho/do/arquivo`. Exemplo:\n\n\u003cimg src=\"./assets/Run-tests-cli-example.png\" alt=\"Run tests cli example\"/\u003e\n\n\u003cimg src=\"./assets/Yoca-order-tests-done.png\" alt=\"Run tests cli example\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcayo-rodrigues%2Fyoca","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcayo-rodrigues%2Fyoca","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcayo-rodrigues%2Fyoca/lists"}