/personal_budget_api_v2

Discover our Personal Budget Planner on GitHub! Simplify your finances effortlessly with our easy-to-use app. Invite family members via email to join in tracking expenses together, promoting transparency and teamwork. No more tangled spreadsheets – our friendly interface makes budgeting a breeze.

Primary LanguageRubyMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Personal Budget Planner API

Introducing our Personal Budget Planner: the easiest way to manage your finances. With our app, effortlessly track your spending and income while collaborating with your family.

Invite your loved ones using just your email. They can join in and track their own finances. It's a simple way to promote transparency and teamwork.

No more complicated spreadsheets. Our user-friendly interface makes budgeting a breeze.

Take charge of your financial future today with our Personal Budget Planner. Achieve your goals and create a healthier financial life for your family.
Explore the docs »

View Demo · Report Bug · Request Feature

Front End Repo Link: Personal Budget Planner UI

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Introducing our Personal Budget Planner: the easiest way to manage your finances. With our app, effortlessly track your spending and income while collaborating with your family.

Invite your loved ones using just your email. They can join in and track their own finances. It's a simple way to promote transparency and teamwork.

No more complicated spreadsheets. Our user-friendly interface makes budgeting a breeze.

Take charge of your financial future today with our Personal Budget Planner. Achieve your goals and create a healthier financial life for your family.

(back to top)

Built With

(back to top)

Getting Started

To get started with our Personal Budget Planner, follow these simple steps:

Prerequisites

For Ruby:

  • ruby --version => ruby 3.2.1

Installation

  1. Clone the repo

    git clone https://github.com/Rustamxon7/personal_budget_v2.git

  2. Personalize .env file

     cp .env.example .env

  3. Run bundle install for Ruby

     bundle install

  4. Run rails db:reset to create, load and seed db

     rails db:reset

  5. Run rails s to start server

     rails s

(back to top)

Usage

This is a simple desciption of how to use our Personal Budget Planner.

(back to top)

Roadmap

  • Login or Use Guest User Button:
    • Launch the application and either log in with your credentials or choose the guest user option to access the basic features.
    • If you are a new user, follow the registration process to create your account.
  • Add Members:
    • Go to sidebar and click on the "Add Members" button.
    • Enter username and press "Add" button.
  • Add Categories:
    • Go to dashboard and click on the "+" button.
    • Enter category name and press "Add" button.
  • Add Transactions:
    • Go to dashboard and click on the "Add Transaction" button.
    • Enter transaction details and press "Add" button.
  • Others:
    • You can edit or delete your transactions and categories.
    • You can also edit your profile information.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Your Name - @twitter_handle - rustamxontolipov788@gmail.com

Project Link: https://github.com/Rustamxon7/personal_budget_v2

(back to top)

Acknowledgments

(back to top)