Sobre a aplicação | Como rodar | Rotas | Licença
Esta é um API para aplicativo "DoWhileApp" tem como objetivo proporcionar um ambiente onde os participantes do Do While 2021 possam comentar suas expectativas sobre o evento que acontecerá em dezembro, observando, em tempo real, as mensagens enviadas por outros participantes também.
- Aplicação construída na aula 01 (de Node) durante a Next Level Week #07: Heat (evento oferecido pela Rocketseat) 🚀
As seguintes tecnologias e ferramentas estão sendo utilizadas neste projeto:
- NodeJS, Express, Insomnia, TypeScript, Web Socket
Antes de começar, você vai precisar ter instalado algumas coisinhas, como o Node.js e o Yarn, é só seguir esse passo a passo aqui. Tenha também o Git, para clonar este repositório!
Com o Node instalado em sua máquina, clone ou baixe este repositório e siga o passo a passo descrito abaixo:
- Cadastre o aplicativo no GitHub (em configurações < ferramentas de desenvolvedor < OAuth Apps),para conseguir acesso ao serviço de autenticação,
colocando a homepage url como
http://localhost:4000
e o redirect comohttp://localhost:4000/sign/callback
, não esquecendo de gerar uma chave secreta, definindo essas configurações também em um arquivo.env
seguindo o exemplo abaixo:
GITHUB_CLIENT_SECRET=
GITHUB_CLIENT_ID=
JWT_SECRET=
Agora, por um terminal...
# Acesse a pasta do projeto em Node
$ cd nlw-07-heat-node
# Instale as dependências
$ yarn
# Rode as migrations
$ yarn prisma migrate dev
# Rode o projeto
$ yarn dev
O servidor inciará na porta:4000. Para utilizar as funcionalidades da aplicação, use o Insomnia para simular requisições e respostas das rotas
GET | POST |
---|---|
http://localhost:4000/github retorna o código de autenticação do GitHub http://localhost:4000/messages/last3 lista as últimas 3 mensagens enviadas http://localhost:4000/profile retorna informações do usuário como nome, avatar, login... |
http://localhost:4000/authenticate verifica o token de autenticação do GitHub do usuário http://localhost:4000/messages cadastrar mensagem |
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.