https://github.com/alejandroq12/pocket-guardian
The Pocker Guardian is a full-stack web application that I created from scratch. My goal is to share knowledge and educate people about money management through quality content. To bring this beautiful piece of technology to life, I am using Ruby on Rails.
https://github.com/alejandroq12/pocket-guardian
erb postgres rails ruby ruby-on-rails sql
Last synced: 2 months ago
JSON representation
The Pocker Guardian is a full-stack web application that I created from scratch. My goal is to share knowledge and educate people about money management through quality content. To bring this beautiful piece of technology to life, I am using Ruby on Rails.
- Host: GitHub
- URL: https://github.com/alejandroq12/pocket-guardian
- Owner: Alejandroq12
- License: mit
- Created: 2024-02-12T19:32:42.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-03-05T22:25:51.000Z (about 1 year ago)
- Last Synced: 2025-01-08T10:45:47.703Z (4 months ago)
- Topics: erb, postgres, rails, ruby, ruby-on-rails, sql
- Language: Ruby
- Homepage: https://pocket-guardian-fec21289dfe6.herokuapp.com/
- Size: 428 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# the-pocker-guardian
The Pocker Guardian
# 📗 Table of Contents
- [the-pocker-guardian](#the-pocker-guardian)
- [📗 Table of Contents](#-table-of-contents)
- [📖 The Pocker Guardian ](#-the-pocker-guardian-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database](#database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Run linter](#run-linter)
- [Deployment](#deployment)
- [Video presentation](#video-presentation)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
The Pocker Guardian is a full-stack web application that I created from scratch. My goal is to share knowledge and educate people about money management through quality content. To bring this beautiful piece of technology to life, I am using Ruby on Rails.
- **It allows the user to create transaction groups.**
- **It allows the user to know the total amount spent.**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
[Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
### Setup
```sh
cd my-folder
git clone https://github.com/Alejandroq12/pocket-guardian.git
```
### Install
Install all necessary dependencies listed in the `Gemfile`.
```sh
bundle install
```
Install all necessary dependencies listed in the `package.json`.
```sh
npm install
```
### Database
```sh
sudo service postgresql start
```
Create database:
```sh
rails db:create
```
Run migrations:
```sh
rails db:migrate
```
Add the seeds:
```sh
rails db:seed
```
### Usage
To run the project, navigate to the project directory and execute the following command:
```sh
rails server
```
### Run tests
To execute all test suites in the application, use the following command in your terminal:
```sh
rspec
```
### Run linter
To run linter, run the following command:
```sh
rubocop
```
```sh
npx stylelint "**/*.{css,scss}"
```
### Deployment
Check my project:
[The Guardian Pocket](https://pocket-guardian-fec21289dfe6.herokuapp.com/)
### Video presentation
Check my video:
[Video presentation](https://www.loom.com/share/1cb735ebf6dc4c8abbf97b4d1b0e12db?sid=dfd22f65-7c8a-4fc7-ac8b-a308e7f8194f)
👤 **Julio Quezada**
- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)
- [ ] **I will add the hamburger button.**
- [ ] **I will add cool statistics.**
Contributions, issues, and feature requests are welcome!
If you like this project please give a star.
Thanks in advance.
This project was inspired by the original design idea by Gregoire Vella on Behance. I extend my sincere appreciation to Gregoire Vella for their innovative and user-friendly design concepts, which have greatly influenced the development of this application. The design adopted for this Ruby on Rails capstone project adheres to the guidelines and aesthetic established by Gregoire Vella, under the terms of the Creative Commons license.
I would like to express my gratitude for the opportunity to learn from such a well-crafted design and for the creative insights it provided throughout the development process. This project not only helped me in honing my skills in Ruby on Rails but also in understanding the importance of user interface and experience in web application development.
Thank you, Gregoire Vella, for your significant contribution to the design community and for providing a source of inspiration for developers like myself.
**What did you learn?**
During the development of this project, I have acquired knowledge in various areas, including the creation of data models, data validation, and testing. I have also learned about processing data, building controllers, controller specs, designing views, and correctly implementing forms. One of the most significant achievements for me was understanding routing. Initially, I struggled with understanding how routes function in Rails. However, it's now clear to me how routes operate and how they should be used. For example, if I want to create a new transaction, I now know how to use the route assigned to the POST method, which corresponds to the 'create' action in the specific controller.
This project is [MIT](./LICENSE) licensed.