FinanceApp

FinanceApp é uma API para controle financeiro pessoal. Permite gerenciar usuários e transações financeiras de forma simples e eficiente.

Requisitos

• Node.js versão 18 ou 20
• Docker
• Docker Compose

Instalação

1. Instale as dependências:

   npm install

2. Configure as variáveis de ambiente copiando o arquivo .env.example para .env e preenchendo com os valores apropriados.

3. Inicie o banco de dados e a aplicação com Docker:

   npm run docker

4. Execute o Prisma:

   npm run prisma-init

5. Inicie o servidor em modo de desenvolvimento:

   npm run dev

Swagger

• Rota para a documentação da API:
  • GET/docs

Schemas

• User

  {
    "type": "object",
    "properties": {
      "id": { "type": "string", "description": "ID do usuário" },
      "firstName": { "type": "string", "description": "Primeiro nome" },
      "lastName": { "type": "string", "description": "Último nome" },
      "email": { "type": "string", "description": "Email do usuário" },
      "password": { "type": "string", "description": "Senha do usuário" }
    }
  }

• Transaction

  {
    "type": "object",
    "properties": {
      "id": { "type": "string", "description": "ID da transação" },
      "user_id": { "type": "string", "description": "ID do usuário" },
      "name": { "type": "string", "description": "Nome da transação" },
      "date": {
        "type": "string",
        "format": "date-time",
        "description": "Data da transação"
      },
      "amount": { "type": "number", "description": "Valor da transação" },
      "type": {
        "type": "string",
        "enum": ["EARNING", "EXPENSE", "INVESTMENT"],
        "description": "Tipo da transação"
      }
    }
  }

Contribuição

Contribuições são bem-vindas! Para contribuir com o projeto, por favor, siga as diretrizes de contribuição descritas no arquivo CONTRIBUTING.md.