/Budget_Capstone

Primary LanguageRuby

logo

Microverse README Template

📗 Table of Contents

📖 [Budget Control]

Budget Control is a mobile web application that can helps you keep track of your daily financially transaction and manage your budget where 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
  • View Template Engine ".erb"
Server
Database

Key Features

  • Register a new user: a new user can register by filling out a form with specific information.
  • User login: a registered user can log in to the app using his credential.
  • Create Category: a user can create a category for his expenses.
  • Create transaction: a user can create a transaction that belongs to a specific category.

(back to top)

🚀 Live Demo

Add a link to your deployed project.

(back to top)

📷 Video Recording

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

  • A Code editor such as VsCode.
  • A web browser.
  • Postgresql, ruby and ruby on rails should be installed on your local machine

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Khaled-AlKhateeb/Budget_Capstone.git

Install

Install this project with:

  cd Budget_Capstone
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec/

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Khaled Al-Khateeb

(back to top)

🔭 Future Features

  • Add categories icon: user can choose a category icon from a list of options.
  • Add confirmation functionality: newly registered users can receive an email to confirm their registration.
  • Sending email for resetting user password

(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 help it stand out by giving it a star ✨

(back to top)

🙏 Acknowledgments

  • I would like to thank Microvers for providing this great opportunity and for the project guide as well 👏
  • Huge appriciation to Gregoire Vella for providing design system guidelines since this project is built upon that ✨

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

  • [Question_1]

    • [Answer_1]

  • [Question_2]

    • [Answer_2]

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