API para o projeto Fincheck, um app para gerenciamento de finanças pessoais! 💸
Aplicação construída em um evento do JStack 🔥
🛠️ Tecnologias e ferramentas: TypeScript, Node, Nest, Prisma, Docker, Insomnia
Com o Node, Yarn e Git instalados, siga o tutorial abaixo:
# Clone esse repositório
$ git clone https://github.com/MariaGabrielaReis/jstack-fincheck-api.git
# Instale as dependências do projeto, assim como suas tipagens
$ yarn
Antes de rodar o projeto, crie o arquivo .env
(na raíz do projeto) com as seguintes variáveis:
# DATABASE
DATABASE_URL="postgresql://<USER>:<PASSWORD>@localhost:5432/fincheck?schema=public"
JWT_SECRET=
Agora execute a aplicação com o comando abaixo, assim o servidor inciará na porta:3333:
# Execute a aplicação
$ yarn dev
Use o Insomnia, por exemplo, para realizar as requisições (importe a coleção deste arquivo).
OBS: Por conta do uso de tokens JWT (neste caso, válidos apenas por 7 dias), será preciso fazer signup e atualizar com o novo token as variáveis de ambiente antes de realizar requisições.
Endpoints disponíveis para Autenticação
Tipo | Ação | Caminho |
---|---|---|
Sign in (entrar) | /auth/signin |
|
Sign up (se cadastrar) | /auth/signup |
Endpoints disponíveis para gerenciamento de Usuários
Tipo | Ação | Caminho |
---|---|---|
Obter dados do usuário logado | /me |
Endpoints disponíveis para gerenciamento de Categorias
Tipo | Ação | Caminho |
---|---|---|
Listar categorias | /categories |
Endpoints disponíveis para gerenciamento de Contas Bancárias
Tipo | Ação | Caminho |
---|---|---|
Listar contas | /bank-accounts |
|
Criar conta | /bank-accounts |
|
Atualizar conta | /bank-accounts/:bankAccountId |
|
Deletar conta | /bank-accounts/:bankAccountId |
Endpoints disponíveis para gerenciamento de Transações
Tipo | Ação | Caminho |
---|---|---|
Listar transações | /transactions |
|
Criar transação | /transactions |
|
Atualizar transação | /transactions/:transactionId |
|
Deletar transação | /transactions/:transactionID |