AlyAtalla / budget-app

Ruby on Rails capstone App

Budget App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Budget App]

[Budget App] a mobile web application designed for budget management. In this application, users can efficiently oversee their financial transactions by categorizing them. By doing so, they can gain insight into their spending patterns, allowing them to track their expenses and understand where their money is allocated. This project not only showcases the use of Ruby on Rails but also serves as a practical tool for individuals to maintain control over their finances.

🛠 Built With

• Ruby on Rails

Tech Stack

Client

• Ruby on Rails

Test

• RSPEC

Database

• PostgreSQL

(back to top)

🚀 Live Demo

• [Live Demo Link][https://budget-app-yyb5.onrender.com/]

(back to top)

🎥 Presentation Video

• [Presentation Video Link][https://www.youtube.com/watch?v=l0NTABh51cI]

(back to top)

Getting Started

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

Prerequisites

• Git/GitHub;
• Optional ( IDE installed in your machine ) - recommended IDE: Vscode;
• Ruby on Rails Installed in your machine;

Setup

• To clone this repo:
  • Open the Terminal(Mac/Linux) or the Cmd (Windows);
  • Navigate to where you want to paste the Repo folder;
  • Run the following commands

git clone https://github.com/fatima-najafi/budget-app.git
cd Budget-App

Install

  bundle install

Setup Database

  rails db:create
  rails db:migrate
  rails db:seed

Usage

rails server

Run tests

rspec spec

Key Features

• Add Category - Add your favorite categories.
• Add Transactions - Add transactions for a specific categories.
• Sign up and log in pages
• Use devise gem for authentication
• Secure app from n+1 problems
• Set up associations between models
• Limit access to webapp resources based on authorization rules
• Unit tests and integration tests - Test methods, controllers and views

👥 Authors

👤 Aly Atalla

• GitHub: @alyatalla
• LinkedIn: @alyatalla

(back to top)

🔭 Future Features

• [Add more dynamic pages]

(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 give ⭐️

(back to top)

🙏 Acknowledgments

I would like to express my gratitude to Microverse for initiating the idea behind this project and Original design idea by Gregoire Vella on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)