Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuyishimireeric/budget-app
https://github.com/tuyishimireeric/budget-app
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tuyishimireeric/budget-app
- Owner: TuyishimireEric
- License: mit
- Created: 2022-11-21T11:25:46.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-11-25T22:45:12.000Z (about 2 years ago)
- Last Synced: 2025-01-09T19:49:12.068Z (17 days ago)
- Language: Ruby
- Size: 620 KB
- Stars: 1
- 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)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**budget_app** is a Ruby on Rails mobile web application that allows users to keep track of their expenses and categories. have a list of transactions associated with a category, so that the user can see how much money it spent and on what.
Client
Server
Database
- **User Authentication**
- **Create categories**
- **Create transactions**
- [Live Demo Link](https://budgetapp.herokuapp.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to work on this project, you need to have the following dependencies installed:
- [Ruby](https://www.ruby-lang.org/en/)
- [Postgresql](https://www.postgresql.org/)
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
- [Rails](https://rubyonrails.org/)
### Setup
Clone this repository to your desired folder:
```bash
$ git clone [email protected]:TuyishimireEric/Budget-app.git
$ cd budget_app
```
### Install
Install this project with:
```bash
$ bundle install
```
To get all the gems required for the project
Then, run
```bash
$ npm install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
bin/rails test test/models/article_test.rb
```
### Deployment
You can deploy this project using:
```sh
Heroku
```
👤 **Tyishimire Eric**
- GitHub: @TuyishimireEric
- LinkedIn: @TuyishimireEric
- E-mail: [email protected]
- [ ] **It will generate the charts with timeline**
- [ ] **It will include the top expenses**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/TuyishimireEric/Budget-app/issues).
If you like this project...
I would like to thank...
All the template colors, font, and layout distribution for the whole project were designed by [Gregoire Vella](https://www.behance.net/gregoirevella) on Behance. A link to the project [can be found here](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=). Check Gregoire for more amazing GUI and Graphic designs!
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._