Giter Club home page Giter Club logo

aprove-me's Introduction

Aprove-me

O projeto é um desafio técnico da BankMe que pedr a criação de uma RESTful API e uma aplicação NextJS (frontend).

Funcionalidades

  • Cadastro de Cedentes e Pagantes
  • Endpoints autenticados com Tokens JWT que expiram após 60s, relacionados ao Id do User que fez a requisição
  • Interface de Cadastro de Pagáveis, Cedentes e Visualizar as informações
  • Sistema de Cadastro de Usuários para o Sistema

Instruções para Inicializar o Projeto

Pré-requisitos:

  • Prisma
  • Instale o Docker

Instalação das Dependências:

Abra o arquivo .env. Altere o parâmetro DATABASE_URL para refletir suas credenciais de banco de dados PostgreSQL:

DATABASE_URL="postgresql://aproveme:aproveme@api-db-1:5432/aproveme?schema=public"

Inicie os containers do Docker com o comando:

docker-compose up

Caso não tenha o yarn instalado ao rodar o comando acima o mesmo irá instalar via pacote npm .

Funcionalidades da API

Cria um usuário

  POST /users
Parâmetro Tipo Descrição
Nome string Obrigatório. O nome do usuário
Email string Obrigatório. O email do usuário
Senha string Obrigatório. A senha do usuário

Faz o login de um usuário

  POST /integrations/auth
Parâmetro Tipo Descrição
Email string Obrigatório. O email do usuário
Senha string Obrigatório. A senha do usuário

Cria um Recebível de um Cedente

  POST /Integrations/payable
Parâmetro Tipo Descrição
id string (UUID) É a identificação de um recebível.
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.
value float Obrigatório. É o valor do recebível.
emissionDate date Obrigatório. É a data de emissão do recebível.
assignor string (UUID) Representa a identificação de um cedente.
id string (UUID) É a identificação de um cedente.
document string(30) Obrigatório. É o documento CPF ou CNPJ do cedente.
email string(140) Obrigatório. É o email do cedente.
phone string(20) Obrigatório. É o telefone do cedente.
name string(140) Obrigatório. É a nome ou razão social do cedente.

Retorna um Recebível

  GET /integrations/payable/{id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.

Retorna um Cedente

  GET /integrations/assignor/{id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.

Deleta um Recebível

  DELETE /integrations/payable/{id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.

Deleta um Cedente

  DELETE /integrations/assignor/{id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.

Edita um Recebível

  PATCH /integrations/payable/{id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.

Edita um Cedente

  PATCH /integrations/assignor/{id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
accessToken string (JWT) Obrigatório. É o token bearer gerado ao logar.

aprove-me's People

Contributors

arthcc avatar diogocezar avatar

Stargazers

Renato Rebouças avatar

Watchers

Danilo Assis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.