Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaog23/fluxos-api
Estou criando um Sistema de fluxo de caixa para mim, controlar minha finanças e abandonar as tabelas de excel
https://github.com/joaog23/fluxos-api
api-rest backend expressjs finances-app jwt-authentication mysql2 node
Last synced: 21 days ago
JSON representation
Estou criando um Sistema de fluxo de caixa para mim, controlar minha finanças e abandonar as tabelas de excel
- Host: GitHub
- URL: https://github.com/joaog23/fluxos-api
- Owner: JoaoG23
- License: mit
- Created: 2022-07-14T01:48:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-17T13:28:47.000Z (about 2 years ago)
- Last Synced: 2023-03-10T00:22:10.464Z (almost 2 years ago)
- Topics: api-rest, backend, expressjs, finances-app, jwt-authentication, mysql2, node
- Language: JavaScript
- Homepage: fluxos-api.vercel.app
- Size: 7.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```markdown
[
{
"idelementos": 1,
"descricao_elementos": ""
},
{
"idelementos": 5,
"descricao_elementos": "Ativo"
}
]
```
Exemplo: Fluxo de caixa:
```markdown
[
{
"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.
2. Clone o projeto.
3. Importe o dump do banco de dados. Localizado no caminho abaixo:
Model\dblfluxosnodb20220902.sql
4. Nomeie um Schema da importação conforme o seu critério com a imagem:
4. Entre no Diretorio no **CMD ou em Outro terminal** de comando.
5. Em seguida volte na pasta raiz
6. **ATENÇÃO** Após isso digite o npm install se caso o dotenv nao for instalado dentro da pasta **raiz** do projeto.
7. 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
5. TCHAM RAMMM Rodando !
6. Use uma API de teste do seu agrado. Ex:Postman, ou Insommia.
7. Importe o arquivo HAR. Path: /api/api-fluxos-v1-har
## Como usar 👨💻
**Iniciar:**
[](https://app.netlify.com/sites/docs-fluxosapi/deploys)
### 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!
[](https://www.linkedin.com/in/joaog123/)
[](mailto:[email protected])
### **License**
[](./LICENSE)