- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
BudgetWise: a web app for easy expense tracking. Register, securely store info, view dashboard of categories and transaction totals. Add new transactions and categories with user-friendly forms. Built on Rails with Devise and Cancancan for security.
Client
Server
Database
- The app should allow users to sign up and log in with their email and password. Access to certain pages should be restricted to logged-in users only.
- Upon logging in, users should see a clean and organized UI with a list of categories. Each category should display its name, icon, and total amount of transactions for that category.
- Users should be able to view a list of transactions for a selected category. Transactions should be sortable based on date, name, or amount, and should display the total amount of transactions for that category at the top of the page.
- Users should be able to add a new category by filling out a form that includes the category name and icon. Upon successful submission, the user should be taken back to the categories page.
- Users should be able to add a new transaction by filling out a form that includes the transaction name, amount, and category. Upon successful submission, the user should be taken back to the transactions page for that category.
- The app should have strong security measures to protect user data and prevent unauthorized access.
To get a local copy up and running, follow these steps.
In order to run this project you need:
- Laptop/Desktop.
- Internet.
- Vs Code.
- Ruby.
- Rails.
- nodejs.
- yarn.js.
- PostgreSQL.
Clone this repository to your desired folder:
cd my-folder
git https://github.com/heintayzar-hm/BudgetWise.git
Install this project with:
cd BudgetWise
bundle install
To run the project, execute the following command:
rails server
or
bin/dev
To run tests, run the following command:
rspec
You can deploy this project using:
https://render.com/
👤 Hein Tay Zar
- Deploy the project and make it available for every one.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project give a ⭐️.
- Thanks to the Microverse team for the great curriculum.
- Hat tip to anyone whose code was used.
- Original design idea by Gregoire Vella on Behance.
This project is MIT licensed.