Budget App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🛠 Live Demo
  • 📇 Entity Relationship Diagram
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Recipe App

Plan Me is 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.The Ruby on Rails application that allows the user to:

• register and log in, so that the data is private to them.
• introduce new transactions associated with a category.
• see the money spent on each category.

🛠 Built With

Tech Stack

Ruby

Ruby on Rails

Bootstrap 5

Database

• PostgreSQL

Key Features

• [Authentication, User can manage his categories and transactions]
• [User must be authenticated]

(back to top)

🛠 Live Demo

(back to top)

📇 Entity Relationship Diagram

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Visual Studio Code
• Git
• Ruby
• PostgreSQL
• Rails

 gem install rails

Setup

Clone this repository to your desired folder:

git clone git@github.com:samlorlah/budget-app-with-rails.git

cd budget-app-with-rails

Install

Install this project with:

  bundle install

  npm install

Create Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate

rails db:seed

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

rspec

(back to top)

👥 Authors

👤 Muyiwa Fawole

• GitHub: @samlorlah
• Twitter: @samlorlah
• LinkedIn: Oluwamuyiwa Fawole

(back to top)

🔭 Future Features

• [Use importmaps or esbuild for loading JavaScript]
• [Notifications that pop up and close]
• [Implement side menu and User settings]

(back to top)

🤝 Contributing

Contributions, 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

I would like to thank:

• Microverse
• Code reviewers
• Inspiration
  • Vitor Guedes Madeira

Under the the Creative Commons liscense

Original design from Gregoire Vella on Behance

(back to top)

📝 License

This project is MIT licensed.

(back to top)