houdamzari / Budget-app

This mobile web app allows users to create categories and add transactions to each category. The app will show the total amount spent on each category. The app is built with Ruby on Rails. The app is deployed on Render.

Budget App

📗 Table of Contents

• 📗 Table of Contents
• Budget App
  • video demo 🎥
  • Render Deploy 🚀
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • Acknowledgments
  • 📝 License

Budget App

This mobile web app allows users to create categories and add transactions to each category. The app will show the total amount spent on each category. The app is built with Ruby on Rails. The app is deployed on Render.

video demo 🎥

Budget-app.mov

Render Deploy 🚀

Live demo here

🛠 Built With

Tech Stack

Server

• Ruby On Rails

back to top

Key Features

• register and log in
• Add new category
• Add new transactions associated with a category.
• see the money spent on each category

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby --version 3.2.1
• Ruby on Rails --version ~> 7.0.4
• Postgresql

Setup

Clone this repository to your desired folder:

  cd your_desired_folder
  git clone https://github.com/MohamedHNoor/Budget-app.git

Install

Install this project gems with:

• After cloning type cd budget-app.
• Run bundle install to install all gems.

Usage

To run the project, execute the following command:

• Run rails db:create to create a new database
• Run rails db:migrate to migrate the db and build the schema
• Run rails s to start the server

Run tests

• Run rspec to run the tests

back to top

👥 Authors

👤 Mohamed Hassan Noor

• GitHub: @MohamedHNoor
• Twitter: @MohamedHNoor
• LinkedIn: @MohamedHNoor

back to top

🔭 Future Features

• implement some UX
• decent desktop design
• Implement the left side menu

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page

back to top

⭐️ Show your support

Give a ⭐️ if you like this project!

back to top

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• Credit to the original designer by Gregoire Vella on Behance

📝 License

This project is MIT licensed.

back to top