Skip to content

Latest commit

 

History

History
209 lines (134 loc) · 5.02 KB

README.md

File metadata and controls

209 lines (134 loc) · 5.02 KB

logo

MyBudget

📗 Table of Contents

📖 MyBudget

MyBudget is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

🛠 Built With

Tech Stack

Client
Server
Database

Key Features

  • User Sign In & Sign Up
  • Add Categories
  • Add Transactions

(back to top)

🚀 Live Video Demo

(back to top)

🚀 Live Demo (Deployed on Render)

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

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone git@github.com:ZikaZaki/mybudget.git

Change directory to the project folder:

  cd mybudget

Install

Install all the dependencies:

  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rails rspec spec

or

  bin/rspec

(back to top)

👥 Authors

👤 Zakariya Al-Khamisi (ZikaZaki)

(back to top)

🔭 Future Features

  • Google Sign-in Option
  • Add Dark Theme to App Settings
  • Weekly,Monthly, & Annual Budget Reports

(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, please give it a ⭐️!

(back to top)

🙏 Acknowledgments

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)