Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonickmumba/budget_app
Budget app is a mobile web application where you 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. It is built using Ruby on Rails.
https://github.com/sonickmumba/budget_app
bullet css devise rails7 rspec
Last synced: 10 days ago
JSON representation
Budget app is a mobile web application where you 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. It is built using Ruby on Rails.
- Host: GitHub
- URL: https://github.com/sonickmumba/budget_app
- Owner: Sonickmumba
- Created: 2023-01-27T17:08:55.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-09-09T12:42:17.000Z (about 1 year ago)
- Last Synced: 2024-11-02T16:25:25.301Z (14 days ago)
- Topics: bullet, css, devise, rails7, rspec
- Language: Ruby
- Homepage:
- Size: 646 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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)
- [❓ FAQ](#faq)
- [📝 License](#license)
**Budget_app** is a mobile web application where one can manage their budget: have a list of transactions associated with a category, so that one can see how much money you spent and on what.
It is built using Ruby on Rails.
# ERD Diagram
Languages
Frameworks
Server
Database
Testing library
- RSpec
- **[A splash screen page]**
- **[A login page]**
- **[A Sign up page]**
- **[A registration page]**
- **[A Category page (with all CRUD implementation, except for 'update')]**
- **[A Transactions page (with all CRUD implementation, except for 'update')]**
- **[Add Transactions page]**
- **[Add Category page]**
- [Live video Link](https://drive.google.com/file/d/1KQV8G0I9ADZehqmSqIhIed0g705Ji97L/view?usp=sharing)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
> Ruby version : `ruby 3.1.2p20`
run `ruby -v`
> Database : **PostgreSQL**
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
git clone [email protected]:Sonickmumba/Budget-app.git
```
-
### Install
Install this project with:
```
cd budget_app
bundle install
```
-
### Usage
To run the project, execute the following command:
```sh
rails server or rails s
```
-
### Run tests
The app is tested using Rspec library you can check the tests by opening your terminal, then change the directory to the location of this repo using this command `cd file_path`, then run this command `gem install rspec`, finally run this command `rspec spec` or `rspec spec --format doc` for documented test results you should see a screen like that comming soon
Example command:
```sh
bin/rails test test/models/article_test.rb
```
-
### Deployment
You can deploy this project using:
- [Live Demo Link](https://tranquil-waters-02647.herokuapp.com)
👤 **Sonick Mumba**
- GitHub: [@Sonickmumba](https://github.com/Sonickmumba)
- Twitter: [@Sonick](https://twitter.com/MumbaSonick)
- LinkedIn: [Sonick Mumba](https://linkedin.com/in/sonickmumba)
- [ ] **[Have a decent desktop design for the webapp.]**
- [ ] **[Implement the left side menu to improve the navigability of the app.]**
- [ ] **[implement some UX improvements: include transitions and/or animations, etc]**
- [ ] **[Add a footer]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Sonickmumba/Budget-app/issues).
If you like this project it a thumb up : 👍 and share this projects with your friends
I would like to thank...
- [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for the design of the project.
- **Microverse** for giving the opportunity to learn
- Code reviewers and coding partners
- Hat tip to anyone whose code was used
- Inspiration
This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.