Skip to content

API afim de gerenciar projetos com nome, data, status e colabores participantes.

Notifications You must be signed in to change notification settings

AndersonCosta28/gerenciador-de-projetos-api

Repository files navigation

🗄️ Gerenciamento de projetos e colaboradores

📝 Descrição

API afim de gerenciar projetos com nome, data, status e colabores participantes.

📚 Funcionalidades

  • Login: Validação de usuário e senha com o banco de dados e autenticação JWT. É necessário fazer login para ter acesso as outras funcionalidades. Acessível na rota (auth/login)
  • CRUD de projetos: Manipulação de projetos.
  • CRUD de colaboradores: Manipulação de colaboradores.
  • CRUD de usuarios: Manipulação de usuarios.
  • Info de rotas do projeto: Documento da API

🔧 Tecnologias utilizadas

🚀 Rodando o projeto

Para rodar o repositório é necessário clonar o mesmo, e executar os seguintse comandos para iniciar o projeto:

<
npm i
npm run build
npm run typeorm migration:run
npm run start
>

⚠️ Avisos

Recomendável ter um arquivo .env na raiz do projeto com os seguintes campos:

  • SECRECT = Este é para o scret do JWT, qualquer string aleatória já serve

🏃 Como funciona:

  1. Executar os comandos para compilar e iniciar o projeto
  2. Com o Postman ou Insomnia, acessar a rota de login http://localhost:3000/auth/login, ele irá usar a porta 3000
  3. No método POST iremos passar no corpo da requisição {"username": "admin", "password": "123456"}, este é o usuário padrão criado a partir da migration
  4. O retorno da requisição acima será um TOKEN JWT que iremos utilizar
  5. Esse TOKEN iremos usar na aba de autorização para utilizar em todos os outros endpoint's, o type é Bearer token, segue o print: Postman, login

Obs.:

  • O token retornado etapa 4 tem tempo de expiração de 1 hora, caso expire é necessário fazer o login novamente etapa 3, gerando um novo TOKEN.
  • Use a rota http://localhost:3000/api/ para ver documentação da api

🤝 Colaboradores

Foto de Mert1s no GitHub
Mert1s

🎯 Status do projeto

  • Concluído

About

API afim de gerenciar projetos com nome, data, status e colabores participantes.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published