Skip to content

Latest commit

 

History

History
195 lines (128 loc) · 5 KB

README.md

File metadata and controls

195 lines (128 loc) · 5 KB

SmartPocket Budget App

📗 Table of Contents

📖 SmartPocket Budget

A budget app named SmartPocket Budget keeps track of all your expenses associated with categories.

🛠 Built With

Tech Stack

Client
Server
Database

Key Features

The main features include:

  • Create new transactions to track your expenses.
  • Update or delete existing transactions.
  • Create new categories to classify your expenses by category.
  • View the calculated total amount of expenses per category.
  • Update or delete existing categories.

(back to top)

🚀 Live Demo

  • The Live Demo is available here
  • Video of the app is available here

(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 >= 3.2.2
    rails >= 7.0
    postgres >- 15.3

Setup

Clone this repository to your desired folder:

  git clone https://github.com/katarighe/budget-app

Install

Install this project with:

  cd budget-app
  bundle install

it will install the required gemfile for running the project

Usage

to use this project:

   bin/rails server or
   rails server

it will run the the server on localhost:3000

to run tests:

(back to top)

👥 Authors

👤 Mohamed Aden Ighe

(back to top)

🔭 Future Features

Here are some future features that could be added to the Budget app in the future.

  • Add Transactions & Animations
  • Introduce a Desktop version
  • Improve the overall UX / UI design

These are just a few ideas for future features that could be added to the Budget app.

The specific features that are added will depend on the needs and wants of the users.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

🙏 Acknowledgments

(back to top)

📝 License

This project is MIT licensed.

(back to top)