/Budget-Manager

Looking to stay on top of your budget? Budget Manager is here to help. This mobile web application lets you create categories and add transactions to keep your finances in order.

Primary LanguageRubyOtherNOASSERTION

logo

📗 Table of Contents

📖 Budget Manager

Looking to stay on top of your budget? Budget Manager is here to help. This mobile web application lets you create categories and add transactions to keep your finances in order.

🛠 Built With

Tech Stack

Server
Database

Key Features

  • User Authentication with devise
  • Bootstrap5 has been used for styling!

(back to top)

🚀 Live Demo

(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 runtime environment
  • Postgresql
  • Rails

Setup

Clone this repository to your desired folder:

Install

Install this project with:

  • Clone the repository using https://github.com/developerwaleed/Budget-Manager.git
  • Navigate to the folder using cd Budget-Manager
  • Use the following commands to
    • install necessary gems bundle install
    • create database rails db:create
    • run migrations and create default user as admin rails db:migrate db:seed

Usage

To run the project, execute the following command:

 rails s

Run tests

To run tests, run the following command:

rspec spec

Deployment

You can deploy this project using:

  • Heroku

(back to top)

👥 Authors

👤 Name Github Twitter LinkedIn
Waleed Amjad @developerwaleed @developerwaleed @developerwaleed

🔭 Future Features

  • Allow users to add their avatar.
  • Create API endpoints to allow users to update their info.

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

(back to top)

🙏 Acknowledgments

We would like to thank microverse for providing the curriculum to guide us on this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)