📗 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 (OPTIONAL)
• 🙏 Copyright
• 📝 License

📖 BUDGET MANAGEMENT

BUDGET APP 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.

🛠 Built With

Tech Stack

Editor

• VSCODE Editor

Framework

• Ruby on Rails

Server

• Ruby

Database

• PostgreSQL

Styling

• Tailwind

Authentication

• Devise

Authorization

• CanCanCan

Testing

• Rspec

Key Features

• Users can register and log in, so that the data is private to them.
• Users must be logged-in to use the app
• Users can introduce new transactions associated with some categories
• Users can see the money spent on each category

(back to top)

🚀 Live Demo

• budget App

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• An editor of your preference, for example VSCODE
• Ruby 3.1.3 or newer
• Rails 7.0.4 or newer
• GIT
• NPM
• PostgreSQL

Setup

Clone this repository to your desired folder:

git clone https://github.com/HansZizold/budget_app
cd ./budget_app

Install

Install this project with:

rails new .
bundle install

Usage

To run the project, execute the following command:

rails server

if you want to modify styles & let tailwind update:

rails tailwindcss:watch

Run tests

To run tests, run the following command:

rspec

(back to top)

👥 Authors

Hans Zizold

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

(back to top)

🔭 Future Features

• Edit and delete Categories
• Edit and delete Transacions

(back to top)

(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

• My loving family 😊
• My partners from Microverse
• Inspiration, Dedication

(back to top)

Copyrights

Original design idea by Gregoire Vella, under Creative Commons License.

📝 License

This project is MIT licensed.

(back to top)