Git Product home page Git Product logo

fluxos-api's Introduction

Fluxos API

Estou criando um Sistema de fluxo de caixa para mim, controlar minha finanças e abandonar as tabelas de excel

Indice 💰

  1. Introdução
  2. Requisitos e Desenvolvimento
  3. Como Instalar
  4. Como Usar
  5. Considerações Finais
  6. Licença

Introdução 💵

Essa API foi desenvolvida de por conta própria, para gestão financeira minha pessoal, baseada uma planilha antiga minha. Com ele posso classificar alguns de meus gastos e ganhos diários.

Requisitos e Desenvolvimento 🤳🔧

Desenvolvimento

Requisitos

Usuário

Criar usuário com login e suas Operações de CRUD.

Manter usuário com controle de acesso selecionando o permissões de prévilegios.

Fluxo de caixa

Possível realizar as operações básica de CRUD e nós mesmo e possível selecionar classificações de dados personalizadas conforme critério que administrador queira. Você verá posteriormente:

Classificações

Será possível também criar como foi dito acima, tipos de classificações personalizadas. Todas eles serão atrelados ao id item do fluxo de caixa:

Exemplo: Classificação Elementos

[
{
"idelementos": 1,
"descricao_elementos": ""
},
{
"idelementos": 5,
"descricao_elementos": "Ativo"
}
]

Exemplo: Fluxo de caixa:

[
{
"id_item_fluxo": 1,
"dia_item_fluxo": 16,
"mes_item_fluxo": 7,
"ano_item_fluxo": 2022,
"hora_item_fluxo": "12:40:59",
"descricao_elementos": "",
"descricao_subelementos": "",
"descricao_tipos": "",
"descricao_subtipos": "",
"descricao_minitipos": "",
"descricao_nanotipos": "",
"descricao_item_fluxo": "Saldo Anterior",
"valor_item_fluxo": "0.00",
"saldo_atual": "0.00"
},
{
"id_item_fluxo": 2,
"dia_item_fluxo": 22,
"mes_item_fluxo": 7,
"ano_item_fluxo": 2022,
"hora_item_fluxo": "18:31:27",
"descricao_elementos": "",
"descricao_subelementos": "",
"descricao_tipos": "",
"descricao_subtipos": "",
"descricao_minitipos": "",
"descricao_nanotipos": "",
"descricao_item_fluxo": "Ganhei na loteria",
"valor_item_fluxo": "100.00",
"saldo_atual": "100.00"
},

Como Instalar 🪛

Usarem o Mysql workbeanch em nosso tutorial

1.Tenha um NODEjs e Mysql 8.0 instalado.

  1. Clone o projeto.

  2. Importe o dump do banco de dados. Localizado no caminho abaixo:

    Model\dblfluxosnodb20220902.sql
    

  1. Nomeie um Schema da importação conforme o seu critério com a imagem:

  1. Entre no Diretorio no CMD ou em Outro terminal de comando.

  2. Em seguida volte na pasta raiz

  3. ATENÇÃO Após isso digite o npm install se caso o dotenv nao for instalado dentro da pasta raiz do projeto.

  4. Após isso crie um .env na pasta raiz e configure apontando para sua base de dados. Conforme abaixo ou como sua preferencia :

Exemplo nao preenchido no arquivo .env.example:

            PORT_SERVIDOR=

            USERDB=
            PORTDB=
            HOSTDB=
            DATABASE=
            PASSWORD=

            TOKEN_SECRET=

Exemplo preenchido .env:

            PORT_SERVIDOR=3000

            USERDB="root"
            PORTDB=3306
            HOSTDB="127.0.0.1"
            DATABASE="db_controllerfluxo"
            PASSWORD="admin"

            TOKEN_SECRET="joao"

8.Após volte para pasta raiz e digite seguinte comando abaixo:

    npm start
  1. TCHAM RAMMM Rodando !
  2. Use uma API de teste do seu agrado. Ex:Postman, ou Insommia.
  3. Importe o arquivo HAR. Path: /api/api-fluxos-v1-har

Como usar 👨‍💻

Iniciar:

Netlify Status

Clique aqui para acessar a documentação completa da API ou fazer um teste caso queira na API em producão..

https://fluxos-api.vercel.app/v1

Clique aqui para acessar a documentacão

  1. Faça login rota inicial. Exemplo: http://localhost:3000/v1/login ou https://fluxos-api.vercel.app/v1/login

  2. Busque o token de acesso na chave do Json Resposta : “tokenUser”

  3. Coloque no cabeçalho

  4. E siga as rotas.

  5. Rota principal fluxo de caixa pode cadastrar um item e classificá-lo conforme o id a aplicação.

Classificações:

Poderá Inserir, deletar, criar, editar qualquer uma dessas. Igual na API:

  • Elementos
  • Subelementos
  • Tipos
  • Subtipos
  • Minitipos
  • Nanotipos

Considerações Finais ✍️

Bom... Isso é somente a API da aplicação. O Front será desenvolvido em outra breve.. Valeu por passar aqui! 😉Um abração de Ursoo 🐻! Volte sempre!

Autor

Feito com 🤭 por Joao Guilherme 👋🏽 Entre em contato!

Linkedin Badge Badge

License

Licence

fluxos-api's People

Contributors

joaog23 avatar

Stargazers

 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.