eventos-api
eventos-api copied to clipboard
Melhorar a documentação do README
Hoje existem algumas "barreiras" para rodar o projeto do zero, seria ideal documentar as informações necessárias para entender como rodar este projeto. Pontos importantes:
- Configuração do Github APP
- Configuração do Firebase Admin
- Configuração de Autenticação do Firebase com o Github
- Secrets e Deploy
Eu fiquei meio perdido tentando iniciar o projeto. Vi que tem a sessão de Run e Dev, mas não sabia qual deveria seguir, então tentei as duas formas. Só depois que entendi que a sessão de Run é apenas para quem está colocando o projeto no ar mesmo.
Seguindo o Dev, eu instalei tudo do projeto e executei o comando npm run dev
. Eu consigo acessar o localhost:3000, mas, todas as rotas que tentei deram Cannot GET *
.
Opa, Realmente ficou faltando a informação:
Depois que você subir o projeto no DEV, você consegue acessar a API através de http://localhost:3000/api
, no seu exemplo precisaria ser http://localhost:3000/api/event