/Enterprises-API

Primary LanguageTypeScript

Enterprises-API

Descrição do Projeto

uma aplicação de gestão de empresas e usuários que são colaboradores dessas empresas, como uma espécie de parte de um ERP - Enterprise Resource Planning.

Topico Completados

  • Cadastro de Usuario
  • Editar de Usuario
  • Detalhar de Usuario
  • Listar de Usuario
  • Cadastrar empresa
  • Editar empresa
  • Listar empresa
  • Detalhar empresa
  • Excluir empresa
  • Vincular Colaborador
  • Desvincular colaborador
  • Listar Colaboradores
  • Anaiador sintático(inter)
  • Formatador de codigo
  • Teste Unitarios
  • PostegreSQL
  • Swagger
  • Bearer-Token

Executando o projeto

  1. Execute yarn dev raiz da aplicação.
  2. Caso não possua o docker instaldo na sua maquina siga essas instruções https://github.com/codeedu/wsl2-docker-quickstart
  3. Execute docker-compose up -d para iniciar o container do redis.
  4. A aplicação estará disponível no endereço http://localhost:3333
  5. Execute yarn test para rodar os testes unitarios da aplicação
  6. Execute yarn migration para rodar as migrations
  7. Documentação em swagger para ter acesso a rota e testar os endpoints com as funções https://localhost:3333/api-docs/)
  8. Rodar em segundo plano em servidor no modo de produção node dist/shared/infra/http/server.js &

Comandos úteis

  • yarn build Gera um build para a produção
  • yarn instalar bibliotecas

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto: