Code Monkey home page Code Monkey logo

financesapp-api's Introduction

⚡ API | Finances App

🤔 Introdução

Esse é o repositório que armazena toda a API para gerenciamento de autenticação, criação de usuários, itens e categorias.

Esse projeto foi desenvolvido usando Node.js, TypeScript como linguagem, Prisma como ORM, Express como Framework e PostgreSQL como banco de dados.

🚪 Rotas Disponíveis

  • GET /users - Lista todos os usuários cadastrados na plataforma (Apenas para Administradores).
  • GET /users/@me - Busca as informações de um usuário.
  • GET /categories - Busca a lista de categorias de um usuário.
  • GET /items - Busca a lista de itens de um usuário.
  • POST /auth - Gera um Token de Acesso para Autenticação.
  • POST /users - Criar um novo usuário.
  • POST /categories - Cria uma nova categoria.
  • POST /items - Cria um novo item.
  • DELETE /categories/:category_id - Remove uma categoria pelo ID.
  • DELETE /items/:item_id - Remove um item pelo ID.

🗄️ Banco de Dados

Todo o banco de dados está sendo gerenciado pelo Prisma, para você rodar todas as migrações, rode o comando npm prisma migrate dev ou yarn prisma migrate dev.

Assim que todas as migrações forem registradas com sucesso, você poderá iniciar a aplicação rodando o comando npm run dev ou yarn dev.

Para você iniciar o processo de Build da aplicação, rode o comando npm run build ou yarn dev. E finalmente, rode o comando npm run start ou yarn start para iniciar o servidor com todos os arquivos gerados pela Build em modo de produção.

⚙️ Como Contribuir

  • Faça um fork desse repositório;
  • Cria uma branch com a sua feature: git checkout -b minha-feature;
  • Faça commit das suas alterações: git commit -m 'feat: Minha nova feature' seguindo algum dos prefixos de commit abaixo:

    ⚠️ Lembrando que será obrigatório a utilização do inglês nas mensagens de commit.

    • feat: - Para implementação de uma nova funcionalidade.
    • fix: - Para a correção de algum Bug.
    • chore: - Para alterações de arquivos sem impacto no projeto.
    • refactor: - Para Refatoração de Código.
    • style: - Alteração na Formatação do código.
    • docs: - Mudanças na Documentação do Projeto.
  • Faça push para a sua branch: git push origin minha-feature.

❤️ Contribuidores do Projeto


@TiaGoiNsaNy

financesapp-api's People

Contributors

tiagoryandev avatar

Stargazers

 avatar  avatar

Watchers

 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.