Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ahmedeid6842/budget_app

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.
https://github.com/ahmedeid6842/budget_app

Last synced: 25 days ago
JSON representation

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.

Awesome Lists containing this project

README 

        
ح





  
Budget App








# 📗 Table of Contents



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

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

    - [Tech Stack](#tech-stack)

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

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#tests)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)



# 📖 Budget App 



**Budget App** 



The Budget App 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 



Ruby on Rails

  



Rspec

  



Capybara

  



Bootstrap

  



## 🚀 Live Demo 



- [Live Demo Link](https://budget-app-microverse-79ca66bb0c60.herokuapp.com/)



(back to top)



## 💻 Getting Started 

The result should look similar to the following data model (this is an Entity Relationship Diagram that you are already familiar with).

![ERD Budget App](https://github.com/microverseinc/curriculum-rails/blob/main/capstone/images/erd_diagram.png)



### Setup 



1. Ensure you have Ruby 3.2.2 at least, installed on your system. You can check your Ruby version in the terminal by running:



```

ruby -v

```



2. You can clone the project :



Using HTTPS:



```

https://github.com/ahmedeid6842/Budget_App.git

```



### Installation 



To run this project locally, follow these steps:



1. Open your terminal or command prompt.



2. Navigate to the directory where you have cloned or downloaded the Budget App repository.



3. Run the following command to install any required dependencies:



```

bundle install

```

4. You need to make sure you have PostgreSQL installed and configured on your local computer   beforehand, then create the database for the project:



```

rails db:create

```



5. Now you need to create the tables and relationships that the project needs:



```

rails db:migrate

```



### Usage 



1. Once the setup is complete, ensure you are still in the directory containing the Budget App files.



2. To run the app, execute the following command:



```

rails s

```



### Tests 



To run the tests ensure you are in the directory containing the test files.



1. Run the tests using the following command:



```

rspec

```



(optional) If you have problem with a different version of 'regexp_parser', you can run the tests with the

version of the gemfile with this command:



```

bundle exec rspec 

```



- All tests should pass without any errors or failures, ensuring that the code and its methods are functioning correctly.



(back to top)



## 👥 Authors 



👤 **Ahmed Eid**

- Github: [@ahmedeid6842](https://github.com/ahmedeid6842/)

- LinkedIn : [Ahmed Eid](https://www.linkedin.com/in/ahmed-eid-0018571b1/)

- Twitter: [@ahmedeid2684](https://twitter.com/ahmedeid2684)



(back to top)



## 🔭 Future 



- [x] **Show Budgets by users**

- [x] **Show Public Budgets**

- [x] **Like Budget and Deals**

- [x] **Enhance UI**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/ahmedeid6842/Budget_App/issues).



(back to top)



## ⭐️ Show your support 



If you like this project give it a star ⭐️



(back to top)



## 🙏 Acknowledgments 

- Original design idea by Gregoire Vella on Behance.

- The design link [behance](https://www.behance.net/gregoirevella)



**I would like to thank Microverse for giving us the opportunity to learn and grow as developers and also I like to thank my family, they are all my support. 🌟**



(back to top)



## 📝 License 



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



(back to top)