Budget Pal is a web app for keeping track of payments, where users can register, create categories, and add payments to one or more category. It also displays the total amount spent on each category. Ruby on Rails was used for the backend/frontend of the app and bulma-css for styles. Also uses the devise gem for authentication
Client/Server
Database
- Data is processed in models
- Users can register
- Users can add categories
- Users can add payments
To get a local copy up and running, follow these steps.
In order to run this project you need:
ruby version 2.7.0+
rails version 7+
PostgreSQL
Yarn
Npm
Clone this repository to your desired folder using this command:
git clone git@github.com:jfoyarzo/budget-app.git
cd budget-app
Install this project's dependencies using:
bundle install
yarn install
npm install
This app uses postgreSQL databases for data preservation. Please provide valid credentials in a .env file and place it in the root folder.
To initialize database run:
rails db:create
rails db:schema:load
To run the server, execute the following command from the root folder of the app:
./bin/dev
You can also use
rails server
this will start the server on http://localhost:3000/
To use the features of the app, you'll have to sign up using:
http://127.0.0.1:3000/users/sign_up
Once you sign up, you can log in from:
http://127.0.0.1:3000/users/sign_in
To run tests, run the following command:
rspec
You can deploy this project using:
TBA
👤 Felipe Oyarzo
- Improved user interface
- Complete CRUD funcionality
- Historical data and metrics
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project please consider giving it a star!
Original design idea by Gregoire Vella on Behance.
I would like to thank Microverse for the opportunity.
This project is MIT licensed.