My Wallet

Ferramentas

Descrição

My Wallet é um sistema de gerenciamento de finanças pessoais, onde você controla seus ganhos e gastos.

Características

Cadastro de usuário e Login;
Controle de entradas e saídas financeiras;

Referências da API

AUTENTICAÇÃO

Cadastro

POST /signUp

Request:

Body	Type	Description
`name`	`string`	Required. Nome do usuário
`email`	`string`	Required. Email do usuário
`password`	`string`	Required. Senha com no mínimo 8 caracteres

Login

POST /signIn

Request:

Body	Type	Description
`email`	`string`	Required. Email do usuário
`password`	`string`	Required. Senha com no mínimo 8 caracteres

Response:

{
	"token": "jasonwebtoken (JWT)",
}

REGISTROS

Adicionar registro

POST /record

Request:

Headers	Type	Description
`Authentication`	`string`	Required. token

Authorization format: Bearer jsonwebtoken

Body	Type	Description
`userId`	`number`	Required. Id do usuário
`value`	`number`	Required. Valor da transição
`description`	`string`	Required. Descrição da transição
`date`	`string`	Required. Data da transição
`type`	`string`	Required. 'incoming' ou 'outgoing
`category`	`string`	Required. Categoria do gasto ou ganho

Buscar registros

GET /records/:userId

Request:

Headers	Type	Description
`Authentication`	`string`	Required. token

Authorization format: Bearer jsonwebtoken

Response:

 [
  {
    "id": 1,
    "userId": 1,
    "value": 100000,
    "description": "Salário de dezembro",
    "date": "02/12",
    "type": "incoming",
    "category": "Salário"
  },
  {
    "id": 2,
    "userId": 1,
    "value": 1000,
    "description": "Padaria",
    "date": "03/12",
    "type": "outgoing",
    "category": "mercado"
  }
]

Variáveis de Ambiente

Para executar este projeto, você precisará adicionar as seguintes variáveis de ambiente ao seu arquivo .env

DATABASE_URL = postgres://UserName:Password@Hostname:5432/DatabaseName

PORT = number #recommended:5000

TOKEN_SECRET_KEY=suasenhasecreta

TOKEN_EXPIRES_IN=1d

Execute Localmente

Clone o projeto

  git clone https://github.com/Leticia-Pinheiro/MyWallet_BackEnd

Vá para o diretório do projeto

  cd MyWallet_BackEnd/

Instale as dependências

  npm install

Inicie o servidor

  npm start

Autora

Letícia Gomez Pinheiro

Linkedin: https://www.linkedin.com/in/leticia-pinheiro-33354a1b6/

GitHub: https://github.com/Leticia-Pinheiro