Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

This is a budget app that allows users to add their expenses categories and expenses. It also allows users to see their total expenses.
https://github.com/ahzamir/budget-app

budget-app css postgresql rspec rspec-rails ruby ruby-gem ruby-on-rails

Last synced: 3 months ago
JSON representation

This is a budget app that allows users to add their expenses categories and expenses. It also allows users to see their total expenses.

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

## Budget App

> This is a budget planner app that allows users to add their expenses categories and expenses. It also allows users to see their total expenses.
![BUDGET APP 3](https://user-images.githubusercontent.com/96838030/217308689-803d9022-f520-470c-aee0-58d885294960.png)

## Live Demo
- [Video demo](https://www.loom.com/share/30f987d8de024de8b90b6ace0016a6d0)
- [Budget_app](https://budget-app-1.onrender.com/)

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

## Built With

- [x] Programming Language: [Ruby](https://www.ruby-lang.org/en/)
- [x] Framework: [Ruby on Rails](https://rubyonrails.org/)
- [x] Linter: [Rubocop](https://rubocop.org/)
- [x] Code Editor: [VS Code](https://code.visualstudio.com/)
- [x] Database: [PostgreSQL](https://www.postgresql.org/)

## Getting Started

To get a local copy up and running follow these simple example steps.

### Install

In the terminal, go to your file directory and run this command.

```
$ git clone https://github.com/ahzamir/budget-app.git
```

### Usage

```
$ cd budget-app
```
```
$ rails server
```

### Setup

```
$ bundle install
```
```
$ yarn install
```
```
$ rubocop .
```

### Run tests

To install rspec, in the terminal kindly run this command

```
$ gem install rspec
```

To run tests, please run this command
```
$ rspec ./spec/#{filename}_spec.rb
```

### Prerequisites

- [x] A web browser like [Google Chrome](https://www.google.com/chrome/).
- [x] A code editor like [Visual Studio Code](https://code.visualstudio.com/).
- [x] A terminal to run the code.
- [x] [Ruby](https://www.ruby-lang.org/en/) installed on your computer.
- [x] [Rails](https://rubyonrails.org/) installed on your computer.

You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```

Likewise for Ruby installation.
```
$ ruby --version && irb
```

To install rails, in the terminal kindly run this command
```
$ gem install rails
```
## Authors

👤 **Ahmad Zamir Yousufi**

- GitHub: [@ahzamir](https://github.com/ahzamir).
- Twitter: [@YousufiZamir](https://twitter.com/YousufiZamir)
- LinkedIn: [ahmad-zamir-yousufi](https://www.linkedin.com/in/ahzamir/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!
- Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).

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

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners

## 📝 License

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

![](https://img.shields.io/badge/Microverse-blueviolet)