Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/munyabelden/budget-app
The App is a web application that helps users manage their expenses by categorizing transactions. It allows users to create categories and add entities (transactions) within each category. Users can track their spending, view the total amount spent in each category, and easily add new transactions.
https://github.com/munyabelden/budget-app
capybara-rspec postgresql rspec-rails ruby-on-rails
Last synced: 17 days ago
JSON representation
The App is a web application that helps users manage their expenses by categorizing transactions. It allows users to create categories and add entities (transactions) within each category. Users can track their spending, view the total amount spent in each category, and easily add new transactions.
- Host: GitHub
- URL: https://github.com/munyabelden/budget-app
- Owner: Munyabelden
- License: mit
- Created: 2023-07-10T07:32:26.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-10-16T10:08:39.000Z (about 1 year ago)
- Last Synced: 2023-10-17T02:49:26.434Z (about 1 year ago)
- Topics: capybara-rspec, postgresql, rspec-rails, ruby-on-rails
- Language: Ruby
- Homepage: https://budget-app-livid.vercel.app
- Size: 635 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**[BudgetPro]** The Budget App is a web application that helps users manage their expenses by categorizing transactions. It allows users to create categories and add entities (transactions) within each category. Users can track their spending, view the total amount spent in each category, and easily add new transactions.
- [ ] Ruby on Rails
- [ ] PostgreSql
- [ ] Gem
Client
Database
- **[Categories: Users can view aand create categories.]**
- **[Entities (Transactions): Entities are ordered by the creation date, with the most recent ones displayed first..]**
- **[Homepage: The app provides a homepage with a default index action.]**
- [Live Demo Link](https://budgetpro.onrender.com)
- [Video presentation](https://drive.google.com/file/d/1THwN1YM60P8RUpRjJzaj5X759qQKAVmk/view?usp=sharing)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [ ] Ruby: [Installation Guide](https://www.ruby-lang.org/en/documentation/installation/)
- [ ] Ruby on Rails: [Installation Guide](https://guides.rubyonrails.org/getting_started.html#installing-rails)
- [ ] PostgreSQL: [Installation Guide](https://www.postgresql.org/docs/)
### Setup
Clone this repository to your desired folder:
```sh
cd Rails_Capstone
git clone https://github.com/Munyabelden/Budget-App.git
```
### Install
Install this project with:
```sh
cd Rails_Capstone
bundle install
```
```sh
gem install rspec
```
```sh
gem install --no-document rubocop -v '>= 1.0, < 2.0'
```
```sh
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```
### Usage
To run the project, execute the following command:
```sh
rails db:create
```
```sh
rails db:migrate
```
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
rubocop --color
```
```sh
npx stylelint "**/*.{css,scss}"
```
```sh
rspec
```
### Deployment
You can deploy this project using:
- [ ] Use render or any other hosting of your choosing
👤 **Belden Mugauri**
- GitHub: [@githubhandle](https://github.com/Munyabelden/)
- Twitter: [@twitterhandle](https://twitter.com/munyaradzi045)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/munyaradzi-mugauri-828a7b24a/)
- [ ] **[Allow users to manage their profile information, including updating their name, email, and password.]**
- [ ] **[Provide options for users to filter and sort entities based on criteria such as date, amount, or category.]**
- [ ] **[Generate visual representations, such as charts and graphs, to help users analyze their spending patterns and track expenses over time.]**
Feel free to check the [issues page](https://github.com/Munyabelden/Budget-App/issues).
If you like this project feel free to give it a star
## 🙏 Acknowledgments
I would like to thank Gregoire Vella on Behance for the original design idea.
This project is [MIT](https://github.com/Munyabelden/Budget-App/blob/feature/app/LICENSE) licensed.