https://github.com/faranoshamini/budget-app
https://github.com/faranoshamini/budget-app
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/faranoshamini/budget-app
- Owner: FaranoshAmini
- License: mit
- Created: 2023-07-04T14:57:51.000Z (almost 2 years ago)
- Default Branch: development
- Last Pushed: 2023-07-16T01:10:25.000Z (almost 2 years ago)
- Last Synced: 2025-02-04T14:47:58.803Z (4 months ago)
- Language: Ruby
- Size: 192 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
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Pay Pros\] ](#-pay-pros-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [🚀 Video Project Presentation ](#-video-project-presentation-)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database creation](#database-creation)
- [Usage](#usage)
- [Run tests](#run-tests)
- [or :](#or-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**This project is a web application designed to help users manage their personal budgets. The app allows users to create and store different categories for their expenses, and track transactions associated with each category. By organizing expenses into categories, users can easily see how much money they're spending in each area, as well as track individual transactions within each category. The user interface is designed to be user-friendly, so users can easily navigate the app and take advantage of its features.**
- View categories for the logged in user
- logged in user can add their categories
- Logged in user can delete a category
- Logged in user can make add purchases to a category
Server
Database
- **Add new categories**
- **Delete categories**
- **Add new transactions for each category**
- **Authentication using Devise gem**
- **Authorization using Cancancan gem**
- **Splash screen showing the name of the App and options to log in/sign up**
## presentation video a name="presentation-video>
- Presentation video
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
> You need the following tools be installed in your computer:
> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
> - IDE
> - PostgreSQL
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/FaranoshAmini/Budget-App.git
```
### Install
Install this project with:
```sh
cd ror-budget-app
bundle install
```
### Database creation
Next, use this command to create the databases:
```
rails db:create
rails db:migrate
```
### Usage
To run the project, execute the following command:
```sh
rails server or rails s
```
### Run tests
To run tests, run the following command:
before you run the tests
```
rails db:seed RAILS_ENV=test
```
```sh
rspec spec/
```
### or :
```
rspec spec/models
rspec spec/views
```
👤 **Faranosh Amini**
- GitHub: [@githubhandle](https://github.com/FaranoshAmini)
- Twitter: [@twitterhandle](https://twitter.com/Faranosh_Amini)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/faranosh-amini-9b925b23a/)
- [ ] **Hamburger menu for the mobile version**
- [ ] **Edit category name, purchase name and amount**
- [ ] **Some UX improvements: include transitions and/or animations, etc.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/FaranoshAmini/Budget-App/issues).
If you like this project please give a⭐️ and share with your friends.
- Thanks to the Microverse team for the great curriculum.
- Hat tip to anyone whose code was used
- I would like to thank "Gregoire Vella" for the [Amazing Design Template](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=).
This project is [MIT](https://github.com/FaranoshAmini/Budget-App/development/LICENSE) licensed.