abatcaverna-api

Pré-requisitos

Antes de começar, certifique-se de atender aos seguintes requisitos:

• Node.js instalado em sua máquina
• npm (Gerenciador de Pacotes Node)

Primeiros Passos

Siga estes passos para configurar e executar o projeto localmente:

1. Clone o repositório:

   git clone https://github.com/abatcaverna/abatcaverna-api.git

2. Navegue até o diretório do projeto:

   cd abatcaverna-api

3. Instale as dependências:

   npm install

4. Configure as Variáveis de Ambiente:

   Crie um arquivo .env na raiz do projeto com base no modelo .env.example fornecido. Modifique os valores conforme necessário.

5. Compile o código TypeScript:

   npm run build

6. Execute o aplicativo:

   npm start

   O aplicativo estará acessível em http://localhost:3333 por padrão. Você pode modificar a porta no arquivo .env.

Desenvolvimento

Para iniciar o servidor de desenvolvimento com recarregamento automático de código:

npm run dev

Este comando utiliza o nodemon para observar alterações nos arquivos TypeScript e reiniciar o servidor conforme necessário.

Testes

Para executar os testes, utilize o seguinte comando:

npm test

Estilo de Código

Utilizamos ESLint para linting de código e Prettier para formatação de código. Certifique-se de executar o seguinte comando antes de enviar uma solicitação pull:

npm run lint

Rotas

• auth
  • manejar sessões dos usuários, armazenar JWT e criar novas sessões
• produtos
  • CRUD produtos no stripe
• access
  • verifica código de acesso dos moradores
• change-password
  • trocar a senha do morador
• recover-password
  • recuperar a senha do morador
• moradores
  • CRUD dos moradores
• tarefas
  • lista de tarefas no excel da rep
• checkout
  • compra no stripe
• webhooks
  • webhooks para verificar ações no stripe

Boas leituras

• Boas práticas
  • Performance
  • Segurança

Stripe

Em alguma rotas é necessário uma conexão com o stripe, para isso é necessário instalar a stripe-cli.

Para iniciar ela é preciso fazer o login, com o comando stripe loing --api-key STRIPE_PRIVATE_KEY.

E para iniciar a ouvir os comando deve iniciar com stripe listen

Background Jobs

Estamos usando o agendajs para fazer as filas e os background jobs, usando como banco o mongodb.

To-do

• Criar instancia do agenda
• Criar jobs de envio de email
  • Checkout
  • Novo usuario
  • Checkout com ingresso
• Criar job para criar pdf do ingresso

Bugs e Melhorias

• Remover senha do retorno da sessao
• Crud de moradores
• Remover stripe e adicionar produto no nosso banco