Budget Buddy

📗 Table of Contents

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

📖 Budget Buddy

The Ruby on Rails capstone project involves developing a mobile web application for budget management. In this project, you will build a Ruby on Rails application that enables users to:

• Register and log in to maintain the privacy of their data.
• Add new financial transactions linked to specific categories.
• Track and visualize their expenses for each category, providing insights into their spending habits.

🛠 Built With

Ruby on Rails

Tech Stack

• PostgreSQL
• Ruby on Rails

Key Features

Key features of the application

• User Registration & Authentication
• Category & Budget Management
• Transaction Management
• Category & Transaction Creation
• Testing (Unit & Integration)
• Technical Stack (PostgreSQL, Devise)
• Security Validation
• Online Deployment

(back to top)

🚀 Live Demo

• Live Demo Link
• Video Presenation

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need

• laptop
• git
• Code Editor.
• PostgreSQL.
• Ruby On Rails.
• Linters

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/SanaTameem/budget-buddy.git

Install

Install this project with:

• Install PostgreSQL.
• Install Ruby On Rails using rails new budget-buddy --database=postgresql command.

  cd my-project
  bundle install

(back to top)

👥 Authors

👤 Sana Tameem

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Features will be added to the project.

• Splash screen
• Sign up and log in pages
• Home page (categories page)
• Transactions page
• "Add a new category" page
• "Add a new transaction" page

(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 like this project, show your support by giving a star ⭐️, thanks in advance.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for including this in their curriculum.
• I would like to thank (Gregoire Vella on Behance)[https://www.behance.net/gregoirevella] for the design of this app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)