jorgeabrahan / budget

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.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Metrics
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Budget app website

Mobile web Budget 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.

Entity Relationship Diagram

Project views

Splash screen

Sign up page

Log in page

Home page

Transactions page

Add a new category page

Add a new transaction page

Tests running

Rspec tests

Capybara tests

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Database

• PostgreSQL

Key Features

• All data is preserved in PostgreSQL
• Sign in and Sign up with devise
• Manage authorization with CanCanCan
• Display all and a single category
• Create categories
• Display all and a single transaction
• Inputs validations in models

(back to top)

🚀 Live Demo

Video walkthrough of the project: https://www.loom.com/share/5288eca2a96e4318b15e30b9a5da4107

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Git SCM
• Ruby installed
• Rails installed
• PostgreSQL and SQL installed

And in case you want to run capybara tests:

• Chromedriver
• WSL activated
• Ubuntu or any other linux distro shell installed

Setup

Clone this repository to your desired folder:

git clone https://github.com/jorgeabrahan/budget.git

Or download the ZIP folder.

Install

Once you've cloned the repository simply run:

bundle install
rails db:create
rails db:migrate

If it doesn't work because the server got disconnected you might need to change the credentials for your own psql credentials in the database.yml file.

Usage

To run the project, if you are on the blog folder path on your terminal you can execute the following command:

rails server

Run tests

To start tests run:

rspec spec # for rspec tests
rails test:system # for capybara tests

Deployment

• Render https://budget-u0h2.onrender.com

(back to top)

👥 Authors

👤 Jorge Abrahan

• GitHub: @jorgeabrahan
• LinkedIn: Jorge Abrahan

(back to top)

🔭 Future Features

• Deploy application in Render
• Improve cyclomathic complexity in some methods

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project you can just cheer me up with a comment 🙂!

(back to top)

🙏 Acknowledgments

Design guidelines for the project: https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=

Original design idea by Gregoire Vella on Behance

Credit to the author following the Creative Commons license of the design

(back to top)

❓ FAQ

• What is this project main purpose?

  • To practice working with Ruby on Rails, PostgreSQL and interpret entity relationship diagrams, UML class diagrams and build UIs in ruby based on design guidelines.

(back to top)

📝 License

This project is MIT licensed.

(back to top)