{"id":20032618,"url":"https://github.com/vagnercardosoweb/nlw5-devquiz-api","last_synced_at":"2025-08-27T02:19:27.348Z","repository":{"id":119658496,"uuid":"360278853","full_name":"vagnercardosoweb/nlw5-devquiz-api","owner":"vagnercardosoweb","description":"API para integrar o APP DevQuiz desenvolvido em Flutter na NLW5 da Rocketseat.","archived":false,"fork":false,"pushed_at":"2021-04-24T06:12:18.000Z","size":807,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-04T00:16:09.568Z","etag":null,"topics":["express","flutter","nlw5","node","postgresql","rocketseat","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/vagnercardosoweb.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":"2021-04-21T19:08:57.000Z","updated_at":"2021-04-25T19:27:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"47048773-5ea7-4136-a2a4-750223f63a52","html_url":"https://github.com/vagnercardosoweb/nlw5-devquiz-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vagnercardosoweb/nlw5-devquiz-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnlw5-devquiz-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnlw5-devquiz-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnlw5-devquiz-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnlw5-devquiz-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vagnercardosoweb","download_url":"https://codeload.github.com/vagnercardosoweb/nlw5-devquiz-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vagnercardosoweb%2Fnlw5-devquiz-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272280358,"owners_count":24906116,"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","status":"online","status_checked_at":"2025-08-27T02:00:09.397Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["express","flutter","nlw5","node","postgresql","rocketseat","typescript"],"created_at":"2024-11-13T09:38:32.199Z","updated_at":"2025-08-27T02:19:27.332Z","avatar_url":"https://github.com/vagnercardosoweb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eNLW5 - DevQuiz - API\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Diagrama db\" src=\".github/diagram-db.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n# Projeto\n\nProjeto tem como objetivo integrar o app desenvolvido em [Flutter](https://flutter.dev/) durante a NLW5\nda [Rocketseat](https://rocketseat.com.br), evento voltado a te levar ao próximo nível como desenvolvedor.\n\n# Tecnologias\n\n- [Express](https://expressjs.com/pt-br/)\n- [TypeScript](https://www.typescriptlang.org/)\n- [PostgreSQL](https://www.postgresql.org/)\n\n# Pré requisitos para rodar o projeto.\n\n- Node v14\n  - npm ou yarn\n- Docker\n\n# Configurando o projeto\n\n```shell\n# Clonar o projeto\ngit clone git@github.com:vagnercardosoweb/nlw5-devquiz-api.git\n\n# Entra na pasta do projeto\ncd nlw5-devquiz-api\n```\n\nAgora você deve configurar as variável de ambiente.\n\n- Copie o `.env.example` pra `.env`\n- Configure as variávies, caso esteja utilizando docker o banco já está configurado para rodar local.\n- Cria duas chaves seguras e mude em `APP_KEY` e `API_KEY`.\n- Caso queira o rastreamento do [sentry](https://sentry.io/welcome/), você deve configurar o `SENTRY_DSN`.\n- A env `APP_ENV` deve ser development para funcionar as `migrations` em ambiente de desenvolvimento.\n\n**APP_KEY**: chave para proteger a criptografia do token JWT.\n\n**API_KEY**: chave para proteger as chamadas as apis quando não tem um token do usuário (JWT).\n\n# Rodando o projeto\n\n```shell\n# Ligando o projeto\nyarn dev:docker\n\n## caso esteja utilizando npm:\nnpm run dev:docker\n\n# Rodando as migrations\ndocker exec nlw5-devquiz-api sh -c \"yarn db:migrate\"\n```\n\n- Todas rotas é protegida por TOKEN, quando não precisa está autenticado deve passar a chave que está no `.env` chamada `API_KEY`.\n- Na documentação em todas rotas tem um **CADEADO** ao clicar vc insere o token e terá acesso as rotas.\n- As rotas que precisa de autenticação você deve passar o **token** retornado no login.\n\n# Documentação da API\n\nA documentação pode ser acessada atrávez [http://localhost:3333/docs](http://localhost:3333/docs)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Swagger\" src=\".github/swagger.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n## Licença\n\nEsse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para mais detalhes.\n\n---\n\nFeito com ♥ by Vagner Cardoso\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvagnercardosoweb%2Fnlw5-devquiz-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvagnercardosoweb%2Fnlw5-devquiz-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvagnercardosoweb%2Fnlw5-devquiz-api/lists"}