Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/barakadanny/budget-app


https://github.com/barakadanny/budget-app

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        



  
Budget App






# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)



# 📖 Budget Buddy 



> Welcome to Budget Buddy, the ultimate budgeting app for keeping track of your finances. With Budget Buddy, you can easily create an account and login to start managing your budget. Create groups to keep track of specific expenses and add transactions to those groups to stay on top of your spending. Budget Buddy makes it easy to stay on top of your finances and stick to your budget.



## 🛠 Built With 



### Tech Stack 



- Ruby on rails

- PostgreSQL

- Tailwind



### Key Features 



- `User account creation and login:` This feature allows users to create a unique account and login to access their budget information.

- `Group creation:` Users can create groups to organize their expenses and transactions, making it easy to track specific areas of their budget.

- `Transactions tracking:` Users can add transactions to their groups, allowing them to keep track of their spending and ensure they stay within their budget.



(back to top)



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

- to have ruby and rails installed



### Setup



Clone this repository to your desired folder:



```sh

  git clone https://github.com/barakadanny/budget-app.git

```



### Install



Install this project with:



```sh

  bundle install

```



### Usage



To run the project, execute the following command:



```sh

  ./bin/dev

```



### Run tests



To run tests, run the following command:



```sh

  rspec

```

(back to top)



## 👥 Authors 



> Mention all of the collaborators of this project.



👨‍💻 **Baraka Danny**



- GitHub: [@barakadan](https://github.com/barakadanny)

- LinkedIn: [danny baraka](https://www.linkedin.com/in/danny-baraka-589156169/)



(back to top)



## 🔭 Future Features 



> Describe 1 - 3 features you will add to the project.



- [ ] Reports and analytics: The ability to view and analyze financial data in the form of graphs, charts, and reports. This will help users to better understand their spending habits and make more informed decisions about their budget.

- [ ] Budgeting goals: A feature that allows users to set financial goals and track their progress towards achieving them. This could include saving for a specific purchase or paying off debt.

- [ ] Integration with banking and financial institutions: This feature will allow users to automatically import and categorize their financial transactions from their bank account, credit cards, and other financial institutions. This will save time and ensure that all transactions are accurately reflected in the budgeting app, providing a more complete and accurate picture of their finances.



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/barakadanny/budget-app/issues).



(back to top)



## ⭐️ Show your support 



> Write a message to encourage readers to support your project



If you like this project...



(back to top)



## 🙏 Acknowledgments 



I would like to acknowledge:



- [Microverse](https://www.microverse.org/) for the opportunity to work on this project

- [The creative common](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=) for the design



(back to top)



## ❓ FAQ 



- **Is Rails relevant in 2023?**



  - [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)



- **Is it easy to learn Ruby on Rails**



  - [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)



(back to top)



## 📝 License 



This project is [MIT](./LICENSE) licensed.



_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._



(back to top)