📗 Table of Contents

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

📖 [BudgetPro]

[BudgetPro] The Budget App is a web application that helps users manage their expenses by categorizing transactions. It allows users to create categories and add entities (transactions) within each category. Users can track their spending, view the total amount spent in each category, and easily add new transactions.

🛠 Built With

Tech Stack

• Ruby on Rails
• PostgreSql
• Gem

Client

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Categories: Users can view aand create categories.]
• [Entities (Transactions): Entities are ordered by the creation date, with the most recent ones displayed first..]
• [Homepage: The app provides a homepage with a default index action.]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

🎥 Video presesntation

• Video presentation

(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:

• Ruby: Installation Guide
• Ruby on Rails: Installation Guide
• PostgreSQL: Installation Guide

Setup

Clone this repository to your desired folder:

  cd Rails_Capstone
  git clone https://github.com/Munyabelden/Budget-App.git

Install

Install this project with:

  cd Rails_Capstone
  bundle install

  gem install rspec

  gem install --no-document rubocop -v '>= 1.0, < 2.0'

  npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

Usage

To run the project, execute the following command:

  rails db:create

  rails db:migrate

  rails server

Run tests

To run tests, run the following command:

  rubocop --color

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

  rspec

Deployment

You can deploy this project using:

• Use render or any other hosting of your choosing

(back to top)

👥 Authors

👤 Belden Mugauri

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

(back to top)

🔭 Future Features

• [Allow users to manage their profile information, including updating their name, email, and password.]
• [Provide options for users to filter and sort entities based on criteria such as date, amount, or category.]
• [Generate visual representations, such as charts and graphs, to help users analyze their spending patterns and track expenses over time.]

(back to top)

🤝 Contributing

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to give it a star

🙏 Acknowledgments

I would like to thank Gregoire Vella on Behance for the original design idea.

(back to top)

📝 License

This project is MIT licensed.

(back to top)