karam084 / budget-app

A budget app built with Ruby on Rails and PostgreSQL. After signing in the user is able to add categories and see how much has been spent in each added category. Can add transactions after selecting the category that they fell under and assign more categories.

Live Demo

link

REQUIRED SECTIONS:

• Table of Contents
• About the Project
  • Built With
  • Live Demo
• Getting Started
• Authors
• Future Features
• Contributing
• Show your support
• Acknowledgements
• License

budget-app

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Recipe App

The Ruby on Rails capstone project (remember what they are?) 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.

Recipe App is a...

🛠 Built With Ruby on Rails and PostgreSQL

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• Ruby on Rails

Server

• Local host

Database

• PostgreSQL

Key Features

• Budget analysis
• Add Budget
• Add Many Groups

(back to top)

💻 Getting Started

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

• Ruby version

• System dependencies

• Configuration

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

Setup

• Download the Zip file or Clone the repo with:
  • git clone https://github.com/karam084/budget-app
  • To access the project directory
  • cd budget-app

Install

• bundle install
• rails db: migrate

Usage

To run the project, execute the following command:

• rails s
• Check http://localhost:3000/ in your browser

Deployment

Run the following command to install all dependencies.

$ bundle install $ code.

Database

To create your local Database

$ rails db: create $ rails db: migrate

Run tests

To install rspec, in the terminal kindly run this command

$ gem install rspec To run tests, please run this command

$ rspec ./spec/#{filename}_spec.rb To run all tests, please run this command

or $ spec

👥 Authors

👤 Karam Fouad

• GitHub: @karam084
• Twitter: @ElarabFouad
• LinkedIn: Karam Fouad

(back to top)

🔭 Future Features

• Doplay App
• Add live demo
• Add Images

(back to top)

🤝 Contributing

CContributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

(back to top)

Video Demo

loom video

Design Template

• I give credit to Gregoire Vella on Behance the author of the original design

📝 License

This project is MIT licensed.

(back to top)