Code Monkey home page Code Monkey logo

nlw-07-heat-node's Introduction

DoWhileApp

Sobre a aplicação   |    Como rodar   |    Rotas   |    Licença

📑 Sobre a aplicação

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) 🚀

🛠️ Tecnologias

As seguintes tecnologias e ferramentas estão sendo utilizadas neste projeto:

  • NodeJS, Express, Insomnia, TypeScript, Web Socket

⚙️ Como rodar

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 como http://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

🛤️ 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

📃 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

image

nlw-07-heat-node's People

Contributors

mariagabrielareis avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.