Sobre | Requisitos | Tecnologias | Como executar | Licença |

🚀 Sobre

Este é um projeto desenvolvido para gerenciar as finanças do usuário, esse repositório contem um API REST em Node.js como back-end e uma aplicação em ReactJS como front-end utilizando TypeScript.

📚 Requisitos

• Ter Git para clonar o projeto.
• Ter Node.js instalado.
• Ter Docker rodando um container PostgreSQL ou o PostgreSQL instalado em sua máquina e configurado.

🚀 Tecnologias

Back-end

• Node.js
• TypeScript
• Express
• TypeORM
• ESLint
• Prettier

Front-end

• ReactJS
• TypeScript
• styled-components
• axios
• ESLint
• Prettier

⚙️ Como executar

    # Clonar o repositório
    $ git clone https://github.com/claudianopl/GoFinances.git

    # Navegar para o diretório
    $ cd GoFinances

Executando o back-end

• No arquivo ormconfig.json configure os parâmetros de acesso ao banco de dados (username, password e database);

• No arquivo src/database/index.jsormconfig.json o nome do banco de dados dos testes (gofinances_tests);

    # Navegar para o diretório do back-end
    $ cd GoFinances/backend

     # instalar as dependências
    $ yarn

    # Executar migrations para criação das tabelas nas base de dados
    $ yarn typeorm migration:run

    # Iniciar o projeto
    $ yarn start

    # Iniciar o projeto em desenvolvimento
    $ yarn dev:server
   
    # Executar testes
    $ yarn test

Executando o front-end

    # Navegar para o diretório do front-end
    $ cd GoFinances/frontend

     # instalar as dependências
    $ yarn

    # Iniciar o projeto
    $ yarn dev:server
   
    # Executar testes
    $ yarn test

    # Executar build
    $ yarn build

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito com 💜 by Claudiano Lima