Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/najibullahjafari/budgetpro
BudgetPro is the Ruby on Rails project, this is about building 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 .
https://github.com/najibullahjafari/budgetpro
backend database gems postgresql ruby ruby-on-rails
Last synced: 12 days ago
JSON representation
BudgetPro is the Ruby on Rails project, this is about building 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 .
- Host: GitHub
- URL: https://github.com/najibullahjafari/budgetpro
- Owner: najibullahjafari
- License: mit
- Created: 2023-10-30T15:35:26.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-03-24T17:07:49.000Z (8 months ago)
- Last Synced: 2024-10-10T08:43:00.043Z (29 days ago)
- Topics: backend, database, gems, postgresql, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 153 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BudgetPro
[](https://codecov.io/gh/cancelei/blog-in-rails)
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 BudgetPro ](#ruby-on-rails-group-project)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**BudgetPro**
The Ruby on Rails capstone project is about building 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.
You can see an introduction of this webpage in this [video](https://drive.google.com/file/d/1HqfuZXhdDsrbV3hWCkM7x45JzBIvJ8Sv/view?usp=sharing)
> So you want to lear more about the tech we have used for this project?
Server
Database
- **Make use for migrations features from Active Record**
- **Include Tables for User, Categories and Transactions**
> If you would like to see this site on action click on the link below:
- [Live Demo Link](https://budget-8wcg.onrender.com/)
To get a local copy up and running, follow these steps.
Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!
### Prerequisites
In order to run this project you need:
first at all, install rails:
```sh
gem install rails
```
after that you have to install postgresql from official [site](https://www.postgresql.org)
then you can go to install part in below1
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/najibullahjafari/BudgetPro
```
### Install
Install this project with:
```sh
bundle install
npm install
```
Setting up the Data Base:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
Before running tests, ensure you've set up the test database:
```sh
bin/rails db:migrate RAILS_ENV=test
```
**Note:** Given that the aim of this project is to test the application's UI, to see if it works without side effects. We have therefore had to modify the contents of certain files, which could have the effect of falsifying certain `Unit` tests.
We therefore recommend that, rather than running all the tests, you only test the `features` folder.
```sh
bundle exec rspec ./spec/features
```
### Install
Install this project with:
```sh
cd RoR-group-project
bundle install
```
Setting up the Data Base:
```sh
rails db:create
rails db:migrate
rails db:seed
```
👤 **Najibullah Jafari**
- GitHub: [Najibullah_jafari](https://github.com/najibullahjafari)
- Twitter: [Najibullah_jafari](https://twitter.com/Najib_Jafari_)
- LinkedIn: [Najibullah_jafari](https://www.linkedin.com/in/najibullahjafari/)
> We this project can improve, we are planning to include the next features soon:
- [x] **User Interface**
- [x] **Validations**
- [x] **API documentation**
- [x] **Model Data**
- [x] **Controllers Testing**
- [x] **Models Testing**
- [x] **View Implementation**
- [x] **User Interface**
- [x] **Validations**
- [x] **API documentation**
- [x] **Model Data**
- [x] **Controllers Testing**
- [x] **Models Testing**
- [x] **View Implementation**
- [x] **Integration Testing**
- [x] **Unit Testing**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/najibullahjafari/BudgetPro/issues).
> Would you like to help?
If you like this project feel free to leave an star, as well if you have a suggestion feel free to visit issues page.
I would like to thank Gregoire Vella due to his effort with this great UI.
> Learn more about FAQ below:
- **How do I fix Linters errors if I modify the project?**
- for rubocop run
```sh
rubocop -A
```
- for Stylint run:
```sh
npx stylelint "**/*.{css,scss}" --fix
```
This project is [MIT](./LICENSE) licensed.