O projeto Finance Flow é uma aplicação Rails que visa ajudar o usuário a controlar suas finanças pessoais. Com ele, é possível anotar pagamentos, contas e categorizá-los de acordo com suas necessidades.
O projeto Finance Flow utiliza as seguintes dependências:
- Ruby: versão 3.0.2
- Rails: versão 6.1.7
- PostgreSQL: versão 1.1
- Puma: versão 5.0
Para instalar o Finance Flow em sua máquina, siga os seguintes passos:
-
Clone o repositório para sua máquina local:
git clone https://github.com/JonathanMuller-bit/finance-flow.git -
Entre no diretório do projeto:
cd finance-flow -
Instale as dependencias:
bundle install -
Crie o banco de dados:
rails db:create -
Execute as migrações do banco:
rails db:migrate -
Execute o servidor:
rails server
Agora, você pode acessar o Finance Flow em http://localhost:3000.
O projeto Finance Flow conta com os seguintes modelos:
- User: representa o usuário que utiliza o aplicativo.
- Entry: representa uma entrada financeira, que pode ser uma despesa (Expense) ou uma receita (Incoming).
- Expense: representa uma despesa financeira, que é uma subclasse de Entry.
- Incoming: representa uma receita financeira, que é uma subclasse de Entry.
- Category: representa uma categoria para as entradas financeiras (Expense ou Incoming).
O projeto Finance Flow conta com testes escritos em RSpec. Para executá-los, basta rodar o seguinte comando:
rspec
Se você deseja contribuir para o projeto Finance Flow, basta seguir os seguintes passos:
- Faça um fork do projeto.
- Crie uma branch para suas alterações:
- Faça suas alterações e adicione-as ao commit:
- Envie suas alterações para o seu repositório forkado:
- Crie um pull request para o projeto original.
Agradecemos qualquer contribuição para o Finance Flow!