Al3xsandro/NlwValoriza

Projeto desenvolvido durante a semana da nlw together promovida pela rocketseat 🚀.

💻 Projeto

⚡ NLW Valoriza

NLW Valoriza, api desenvolvida durante a sexta edição da nexlevelweek.

✨ Tecnologias

Esse projeto foi desenvolvido com as seguintes techs:

• Typescript
• Express
• TypeORM
• Jest
• Jwtwebtoken
• Bcryptjs

🚀 Como usar

Autenticação

• Cadastro:

  • http://localhost/users

    • Faça uma requisição POST enviado o seguinte body:

       {
           "email": "seu email",
           "password": "sua senha"
       }
      

• Obter token jwt:

  • http://localhost/login

    • Faça uma requisição POST enviando o seguinte body:

      {
          "email": "email cadastrado acima",
          "password": "senha cadastrada acima"
      }
      

    • Após isso você irá receber seu token jwt

Elogios

• Pesquisar elogios

  • http://localhost/tags/:elogio:
    • Faça uma requisição GET e vai receber informações sobre a tag.

• Enviar um elogio

  • http://localhost/tags/compliments

    • Faça uma requisição POST com esse body:

      {
        "tag_id": "id do elogio",
        "user_receiver": " id do usuário que vai receber ",
        "message": " messagem que vocẽ deseja enviar "
      }
      

🔥 Como executar

🐘 Migrations

• Clone o projeto em sua maquina:

   $ git clone https://github.com/Al3xsandro/nlwValoriza.git
  

• Apos isso configure o arquivo dotenv

  • é possível encontrar o arquivo na raiz de seu projeto

    .env.example
    

  • Preencha as credenciais e execute esse comando em sua maquina:

    $ yarn typeorm migrations:run
    

  • Aguarde retornar as migrações foram geradas com sucesso, e faça as próximas etapas.

🧶Com yarn

• Clone o projeto em sua maquina:

   $ git clone https://github.com/Al3xsandro/nlwValoriza.git
  

• Verifique se você tem o node e yarn instalado em sua maquina

    $ node -v;yarn -v // vai retornar a versão dos dois
  

• Digite o comando abaixo para instalar as dependencias do projeto:

    $ yarn
  

• Por fim execute:

   $ yarn dev
  

• Agora você já pode acessar a api em seu navegador ou proxy!