📗 Table of Contents
- 📖 About the Project
💻 Getting Started👥 Authors🔭 Future Features🤝 Contributing⭐️ Show your support🙏 Acknowledgements📝 License
📖 Budget app
The Budget app is about building a mobile web application where you can manage your budget: you have a list of expenses associated with a categorie, so that you can see how much money you spent and on what.
Video for explanation
🛠 Built With
Tech Stack
Server
Database
Key Features
- User can Sign_up and Sing_in
- User can Add new Category
- User can Create new Expense
- User can upload an image for each Category or Expense
🚀 Live Demo
Please click the link below to open our webpage in your browser
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- IDE or code editor: VsCode, atom, sublime...
- To have Ruby, RoR gem and Git installed on your system.
Setup
Clone this project on your local machine using the following command on your terminal:
https://github.com/Olivier-Kango/rails_budget_app.git
Install
Run the following command to install all project's dependencies:
bundle install
Run the following command to install Rspec for tests:
gem install rspec
Usage
To run the project, execute the following command:
rails s
Run Tests
Run the following command to catch all style errors:
rubocop
Run the following command for the rspec tests(with details):
rspec ./spec --format documentation
Deployment
You can deploy this project using:
👥 Author
- GitHub: @github_olivier
- Twitter: @twitter_olivier
- LinkedIn: @LinkedIn_olivier
🔭 Future Features
Features to add to the project.
- Delete and edit each Category or Expense
- Implement some UX improvements: include transitions and/or animations, etc.
- Make a Desktop design for the webapp
- Implement the left side menu to improve the navigability of the app
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
Give this project a star if you like it !
🙏 Acknowledgments
I would like to thank:
- Gregoire Vella for the website design system that inspired my design.
- Theophile Kango and My cording partners.
❓ FAQ
-
Do I have to have any previous knowledge about ruby to use this project?
- No!
-
How to use this project?
- check the Getting Started section to have a complete guid on how to setup and run teh project.
📝 License
This project is MIT licensed.