https://github.com/lordksix/budget-app-by-rails
Ruby on Rails web application with PostgreSQL as database. It allows to manage your budget by creating categories of expenses, and transactions for each category.
https://github.com/lordksix/budget-app-by-rails
Last synced: about 2 months ago
JSON representation
Ruby on Rails web application with PostgreSQL as database. It allows to manage your budget by creating categories of expenses, and transactions for each category.
- Host: GitHub
- URL: https://github.com/lordksix/budget-app-by-rails
- Owner: lordksix
- License: gpl-3.0
- Created: 2023-09-12T01:03:43.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-16T01:20:31.000Z (over 1 year ago)
- Last Synced: 2024-05-17T15:48:24.833Z (about 1 year ago)
- Language: Ruby
- Homepage: https://budget-by-lordksix.onrender.com/
- Size: 6.18 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Budget by Lordksix
# 📗 Table of Contents
- [📗 Table of Contents](#table-of-contents)
- [📖 Budget by Lordksix](#about-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](#️support)
- [🙏 Acknowledgments](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
**Budget by Lordksix** is a Ruby on Rails web application with PostgreSQL as database. It allows to manage your budget by creating categories of expenses, and transactions for each category.
For a video explanation, please [here]()
Client
Server
Database
- **Gitflow**
- **Linters implemented**
- **Rubocop implemented**
- **Implement Model Migrations**
- **Implement Implement TailwindCSS**
- **Implement unit and integrations tests**
- **Implement authentication and authorization**
- **Use PostgreSQL**
## 🚀 Live Demo
>[Live Demo](https://budget-by-lordksix.onrender.com/)
> [Video Presentation](https://www.loom.com/share/bd25e5f6f20846828c31d7e837893961?sid=cf3a0e39-bdb6-465a-a91f-a3f6d6808155)
### Prerequisites
In order to run this project you need:
- To clone or fork this repo
- Ruby installed in your machine
- Ruby on Rails gem installed
- PostgreSQL install in you computer
- To modify this profile you will also need a text editor
For more information on how to install ruby on your machine:
### Setup
Clone this repository to your desired folder:
For example, using Ubuntu:
```sh
cd my-desired-folder
git clone https://github.com/lordksix/budget-app-by-rails.git
```
For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo
### Install
To install dependencies, the following command must be run in the terminal:
```sh
cd budget-app-by-rails
bundle install
```
To create database, migrate schema and implement initial database entries
```sh
rails db:drop db:setup
```
### Usage
In the project directory, run the first time:
```sh
bundle exec rake assets:precompile
```
then, you can use:
```sh
./bin/dev
```
or:
```sh
rails s
```
Check on db/seed.rb for pre-loaded users, groups and, spendings, and likes for development
### Run tests
In the project directory, run the first time:
```sh
bundle exec rake assets:precompile
```
then, you can:
```sh
rspec .
```
however, if you haven't run `./bin/dev`
👤 **lordksix**
- GitHub: [@lordksix](https://github.com/lordksix)
- LinkedIn: [@wladpasquel](https://www.linkedin.com/in/wladpasquel/)
- Medium: [@wladimir.pasquel](https://medium.com/@wladimir.pasquel)
Future changes:
- Implement external authentication.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
We would like to thank Microverse for the idea for this project.
Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).
- **Do I need a IDE or a special text editor to make changes?**
- No, you don't. You can use NotePad to make changes.
This project is [GNUv3](./LICENSE) licensed.