- π Table of Contents
- πΈ Grow Rich
- π Built With
- π² Key Features
- π Live Demo
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgments
- π License
Grow Rich is a mobile web application where you can manage your budget: you have a list of transactions associated with a budget, so that you can see how much money you spent and on what.
Domain | Tech Stack |
---|---|
Server | Ruby on Rails |
Database | PostgreSQL |
Testing Framework | RSpec Rails, Capybara |
Authentification | Devise |
Authorization | cancancan |
- Create a new account
- Log in to an existing account
- Sign out from a session
- Create a Budget(s)
- Add expenses to a budget
- Check the list of expenses for a particular budget
- Display the total amount of expenses for a particular budget
- Tests for budgets
- Tests for expenses
- Dynamic navbar
π Live Demo
π Video Walkthrough
To get a local copy up and running, follow these steps.
In order to run this project you need:
-
Ruby 3.2.2 installed
-
Rails installed
Run this command to install Rails
gem install rails
Clone this repository to your desired folder:
Example commands:
cd my-folder
git clone https://github.com/Kwaku28/Grow-Rich.git
To install dependencies, run:
bundle install
Set up the database
To create the database, run:
rails db:create
To create/update the schema, run:
rails db:migrate
To run the project, execute the following command:
# Comment out the following lines of code in the config/puma.rb file:
workers ENV.fetch("WEB_CONCURRENCY") { 4 }
preload_app!
rails server
To run tests, run the following command:
rspec
π€ Lawrence Amoafo
- GitHub: @Kwaku28
- LinkedIn: Lawrence Amoafo
- Delete a budget
- Edit a budget
- Delete an expense
- Edit an expense
- Set an allowable amount for a budget
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Your support is crucial to the success of this project! There are ways you can contribute and show your support:
-
Provide Feedback: If you've tried out the project or have any suggestions for improvement, I would love to hear from you. Your feedback is invaluable in shaping the future direction of the project.
-
Kindly Give a π STAR π if you like this project!
Remember, your support matters! Whether it's spreading the word, providing feedback, reporting issues, contributing code, or making a donation, every action makes a difference. Together, we can make this project even better.
Thank you for your support and for being a part of this journey! β€οΈ
I would like to thank:
- Microverse
- Gregoire Vella for the original design idea
- Code Reviewers
This project is MIT licensed.