https://github.com/developertariq/rails-budget-app
https://github.com/developertariq/rails-budget-app
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/developertariq/rails-budget-app
- Owner: developertariq
- License: mit
- Created: 2023-04-28T11:47:46.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-04T11:26:39.000Z (about 3 years ago)
- Last Synced: 2025-02-04T12:48:39.076Z (over 1 year ago)
- Language: Ruby
- Size: 214 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe App
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [Budget App ](#budget-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Live Demo ](#live-demo-)
- [Presentation ](#presentation-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Run](#run)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [Acknowledgments](#acknowledgments)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
**Budget App** is the Ruby on Rails capstone project is about building a mobile web application where user 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.
You will create a Ruby on Rails application that allows the user to:
- register and log in, so that the data is private to them.
- introduce new transactions associated with a category.
- see the money spent on each category.
## 🛠 Built With
Server
Click to observe the [live project](https://tariq-budget-app.onrender.com/)
Click to watch the [presentation on project](https://www.loom.com/share/f95e5751ddd5465ca06f77281437ab3b)
- User can manage their budget.
- Dispaly list of transactions associated with a category.
- Users can see where they spent the money.
## 💻 Getting Started
### Prerequisites
* Make sure you have Ruby installed in your system. You can install it [here](https://www.ruby-lang.org/en/documentation/installation/)
* Get started with [Ruby on Rails](https://guides.rubyonrails.org/getting_started.html).
* Make sure you have [PostgreSQL](https://www.postgresql.org/) installed and running.
### Setup
* Clone this repository by running `git clone https://github.com/developertariq/budget-app.git` in your command line.
* Navigate to the repository by running `cd my-blog`.
### Install
* Run `bundle install` to install all the gems.
### Run
* Change/include `host, username, password` according to your database server.
* Run `rails db:create` and `rails db:migrate`
* Run `rails s` to start the server.
* In your browser, go to `http://localhost:3000`.
### Run tests
* Run `gem install rspec` to install Rspec,
* Run `rspec spec` to run all the test cases, and
* Run `rspec spec/models` to run test cases for `models`.
* Run `rspec spec/requests` to run test cases for `controllers`.
* Run `rspec spec/features` to run test cases for `views`.
* Run `rspec spec/filepath/filename.rb` to run test cases individually.
👤 **Md Tariq-ul Islam**
- [GitHub](https://github.com/developertariq)
- [Twitter](https://twitter.com/developer_tariq)
- [LinkedIn](https://www.linkedin.com/in/developer-tariq//)
- [ ] **Online payment**
- [ ] **User information update**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/developertariq/budget-app/issues)
Give a ⭐️ if you like this project!
## Acknowledgments
Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).
License of the design under The [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/).
- Do I have to have any previous knowledge about ruby to use this project?
- No!
- How to use this project?
- check the [Getting Started](#getting-started) section to have a complete guid on how to setup and run teh project.
This project is [MIT](./LICENSE) licensed.