📗 Table of Contents

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

📖 Smart budget

Smart budget is a web application that allows a user to register and track their expenses grouped under categories.

🛠 Built With

Tech Stack

Client

• HTML5
• CSS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create categories
• Create transactions grouped under categpries
• View transactions and transaction totals grouped by categories

(back to top)

🚀 Live Demo

• Live Demo Link

🎁 Project Presentation

• Live Demo Link

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

• Postgres DB version 11.17 or greater
• Ruby version 3.1.2 or greater
• Rails version 7.0.4 or greater

Setup

Clone this repository to your desired folder: git@github.com:wayungi/budget_app.git

Example commands:

• open the terminal in your parent directory
• Run sh git clone git@github.com:wayungi/budget_app.git
• sh cd budget_app
• Run sh bundle install

Usage

To run the project, execute the following command:

• Run sh rails server
• Open your browser and go to localhost:3000

Run tests

To run tests, run the following command: sh rspec spec

(back to top)

👥 Authors

👤 Francis Wayungi

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

(back to top)

🔭 Future Features

• Large screen version
• Limits to expenses per category
• Email notification when category expenses exceed a set limit

(back to top)

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, please support me at

(back to top)

🙏 Acknowledgments

I would like to thank...

• Microverse
• Original design idea by Gregoire Vella on Behance
• Vannesa Bonito

(back to top)

❓ FAQ

• Is it a desktop, web or android project?

  • The project is web based, currently is optimized for small screens.

• I have earlier versions of Ruby, Rails and Postgres, will the project run on my machine?

  • Yes, the project will run but may also break due to breaking changes in the versions. for best expereienec, upgrate to the preffered vesrions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)