Endpoints • Pré-requisitos • Rodando a Aplicação • Tecnologias • Autor
Endpoints - Topo
| Método HTTP | Rota | Descrição |
|---|---|---|
| POST | [url_base]/users | Possibilita o cadastro de novos usuários |
| GET | [url_base]/users | Possibilita listar todos os usuários cadastrados. Requer autenticação |
| POST | [url_base]/login | Possibilita a autenticação de um usuário |
| POST | [url_base]/tags | Possibilita o cadastro de novas tags de identificação de elogios. Requer autenticação |
| GET | [url_base]/tags | Possibilita listar todas as tags de identificação de elogios cadastradas. Requer autenticação |
| POST | [url_base]/compliments | Possibilita o cadastro de novos elogios. Requer autenticação |
| GET | [url_base]/users/compliments/send | Possibilita listar os elogios feitos pelo usuário autenticado |
| GET | [url_base]/users/compliments/receive | Possibilita listar os elogios recebidos pelo usuário autenticado |
Pré-requisitos - Topo
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git e Node.js
Além disto é bom ter um editor para trabalhar com o código como o VSCode. É aconselhável também utilizar algum programa que possibilite o consumo da api como o Insomnia ou alguma extensão do VSCode como a Thunder Client.
Para finalizar, precisará também configurar um segredo (app secret) para que seja possível realizar a autenticação através do JWT.
Deve-se inserir a informação do segredo em um arquivo de variáveis de ambiente.
# Utilize o arquivo presente no projeto chamado .env.example
# JWT
APP_API_SECRET=Para poder criar o segredo da aplicação basta ir em qualquer site de geração de hash, como o MD5 Hash Generator.
Rodando a Aplicação - Topo
# Clone este repositório
git clone https://github.com/RicardoOliveiraFilho/NLW06-valoriza.git
# Acesse a pasta do projeto no terminal, a partir do diretório ao qual o comando de clonagem foi executado
cd NLW06-valoriza
# Instale as dependências
$ yarn install ou
$ npm i
# Com as dependências instaladas execute o seguinte comando - ele fará com que as tabelas sejam criadas
$ npm run typeorm migration:run
ou
$ yarn typeorm migration:run
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
$ yarn dev
# O servidor iniciará na porta:3000
# Acesse http://localhost:3000 em qualquer navegador de sua máquina.
# Para mais detalhes sobre os endpoints da aplicação, acesse sua documentação através do endereço http://localhost:3000/api-docs
# O Servidor deve estar em execução para poder acessar a documentação...Tecnologias - Topo
As seguintes ferramentas foram usadas na construção do projeto:
Autor - Topo
Feito por Ricardo Oliveira - Entre em contato!