README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Budget app project

This Ruby on Rails project is about a mobile 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.

🛠 Built With

Tech Stack

This project is built using the following technologies:

Programming languages

• CSS
• Ruby on rails

Key Features

The app allows the user to:

• Register and log in, so that the data is private to them.
• Introduce new transactions associated with a category.
• See the money spent on each category

(back to top)

🚀 Live Demo & Video presentation

• Check the live demo, mobile version
• Check quick demonstration of the app video by clicking the link

(back to top)

💻 Getting Started

To get started with the Buget app, follow the steps below:

Prerequisites

Before running this project, make sure you have the following prerequisites installed:

• Ruby on rails
• A Chrome browser

Installation

1. Clone this repository to your desired folder:

   git clone https://github.com/pushkar1995/budget-app.git
   

2. Navigate to the project directory:

   cd budget-app
   

3. Run the program:

   bundle install
   rails s
   
   

Run tests

To run tests after setting up the linters, run the following command:

  rubocop

  npx stylelint "**/*.{css,scss}"

  Rspec spec

👥 Author

👤 Pushkar Gautam

• GitHub: @pushkar1995
• Twitter: @Pushkar9951
• LinkedIn: pushkargautam

(back to top)

🔭 Future Features

In near future I am planning to implement the following:

• UX improvements: include transitions and/or animations, etc.
• Implement the left side menu to improve the navigability of the app.

🤝 Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like my page please show your support and give this page a star!
![Star]

(back to top)

🙏 Acknowledgments

I would like to express my sincere gratitude to Gregoire Vella for the original design idea and for the kindness of allowing students to use his page as a template.

I would like to extend my heartfelt gratitude to Microverse for providing me with the opportunity to undertake this capstone project. Additionally, I am immensely thankful to the code reviewers who took the time to assess my work and provide valuable feedback, which greatly contributed to the refinement and success of the project. Your guidance and support have been invaluable throughout this solo endeavor, and I am truly grateful for your contributions.

(back to top)

📝 License

This project is MIT licensed.