- ๐ About the Project
- ๐ป Getting Started
- ๐ฅ Authors
- ๐ญ Future Features
- ๐ค Contributing
- โญ๏ธ Show your support
- ๐ Acknowledgements
- โ FAQ (OPTIONAL)
- ๐ License
A web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.
Client
Server
Database
- [authentication system to allow login and registration]
- [list categories of items you spend on]
- [list transactions for a specific category]
To get a local copy up and running, follow these steps.
In order to run this project you need followed installed on your computer:
- Ruby v3+,
- Rails v7+
- PostgreSQL
- An IDE e.g Visual studio code.
- A terminal.
Clone this repository to your desired folder or download the Zip folder:
git clone https://github.com/devMunyi/Budget-Tracker
- Navigate to the location of the folder in your machine:
you@your-Pc-name:~$ cd Budget-Tracker
To install all dependencies, run:
bundle install
- Create
.env
file and add the following three lines(be sure to replace with your details):
DB_HOST='localhost'
DB_USERNAME='your_postgress_username'
DB_PASSWORD='your_postgress_password'
- Then run the following command:
rails db:create db:migrate
To run the project, follow these instructions:
- To get it running on your machine, you may open the project on your IDE and open the terminal
- On the terminal you can run:
rails s OR rails server
- To run rubcop tests, run the following command:
rubocop
- To run rspec tests, run the following command:
rspec
๐ค Samuel Munyi
- GitHub: @devMunyi
- LinkedIn: Samuel Munyi
- Twitter: @munyi_sam
- Implement more methods and features.
- Improve the UI.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a โญ๏ธ if you like this project and how I managed to build it!
- The original design idea by Gregoire Vella on Behance.
- Project from Microverse Ruby on Rails module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
- Hat tip to anyone whose code was used.
-
Can I fork and reuse the repository
- Yes please, feel free.
-
Can I improve the repository, and my changes will be accepted if they are good?
- Yes please, nice ideas are welcome, please.
This project is MIT licensed.