studiosnabeel/budget-app

The budget-app repository contains the code for a web-based budgeting application built using Ruby on Rails and PostgreSQL. This application allows users to track their income and expenses and provides a visual representation of their budget. Users can add or remove income and expenses.

📗 Table of Contents

• 📗 Table of Contents
• Budget App
  • Built With
    • Tech Stack
    • Key Features
  • Live Demo
  • Getting Started
    • Prerequisites
    • Setup
    • Available Scripts
  • Author
  • Future Feature
  • Contributing
  • Show your support
  • Acknowledgments
  • License

PocketPal

PocketPal App is a web-based budgeting application built using Ruby on Rails and PostgreSQL. This application allows users to track their income and expenses and provides a visual representation of their budget. Users can add or remove income and expenses, and the application automatically calculates the remaining budget. The website is responsive and optimized for use on desktop and mobile devices. If you have any feedback or suggestions, please feel free to create an issue or submit a pull request.

Built With

Tech Stack

• Ruby 3.1
• Ruby on Rails 7
• PostgreSQL 15

Key Features

• Register an account
• Create categories and transactions
• Metrics about user transactions

Live Demo

• not available
• Video Presentation of PocketPal App

Getting Started

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

Prerequisites

• Ruby
• Ruby on Rails
• PostgreSQL
• any code editor

Setup

To setup the project follow the steps:

1. Clone this project using Git Bash:

   git clone git@github.com:Sajeelzafar/budget_app.git
   

2. Inside the project directory, install the project's dependencies

   bundle install
   

3. Create the app's database

   rails db:create
   

4. Setup the app's database

   rails db:setup
   

Available Scripts

In the project directory, you can run:

• rails server
  

  Runs the app local server

• bundle exec rspec
  

  Launches the test runner.

Author

👤 Nabeel Akbar

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

Future Feature

• Create a user profile
• Create a desktop version

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project give it a star!

Acknowledgments

• Microverse ❤️

• Credit goes to Gregoire Vella on Behance whose original design was used.

License

This project is MIT licensed.