📗 Table of Contents

• 📗 Table of Contents
• 📖 [budget-app]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [budget-app]

[budget-app] is a Ruby on Rails application that allows users to create budgets and track their expenses.

🛠 Built With

Tech Stack

Ruby

• Ruby

Rails

• Ruby on Rails

Postgresql

• Postgresql

Key Features

• Create new transaction groups.
• Create new transactions.
• View all transactions.
• View all transaction groups.
• View all transactions for a specific group.

(back to top)

🚀 Live Demo

See Project 🚀

Presentation video

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need to have ruby, rails and postgres installed.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone github.com/microhass/budget-app.git

Then navigate to budget-app folder:

cd budget-app

Install necessary dependencies:

bundle install

Then start the app server:

rails serve

Visit http://127.0.0.1:3000/ to view the app.

(back to top)

👥 Authors

👤 Hassan Shakur

• GitHub: @hassanShakur
• Twitter: @HassShakur
• LinkedIn: hassanShakur

(back to top)

🔭 Future Features

• Implement the desktop version of the app.
• Improve on the mobile UI and UX.
• Add more features to the app.
• Add more tests.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you'd like to contribute to this project, feel free to fork the repository and make changes as you see fit. Please submit a pull request with your changes and I'll review them as soon as possible.

(back to top)

🙏 Acknowledgments

I would like to thank my coding partners and mentor for the support, and Microverse for the opportunity.

Special thanks to Gregoire Vella on Behance for the design inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)