Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pablobona/budget

The Budget App is a mobile web application built on Ruby on Rails that enables you to effectively manage your finances. It provides a detailed list of transactions categorized by type, allowing you to track your expenditures and gain insights into your spending patterns.
https://github.com/pablobona/budget

backend cancancan devise frontend rails ruby

Last synced: 14 days ago
JSON representation

The Budget App is a mobile web application built on Ruby on Rails that enables you to effectively manage your finances. It provides a detailed list of transactions categorized by type, allowing you to track your expenditures and gain insights into your spending patterns.

Awesome Lists containing this project

README

        

# 4Budget: Personal Finance Management App

## 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Build With](#build-with)
- [Tech Stack](#tech-stack)
- [Client](#client)
- [Server](#server)
- [Database](#database)
- [Key Features](#key-features)
- [💻 Live Demo](#live-demo)
- [📸 Screenshots](#screenshots)
- [📖 Getting Started](#started)
- [🛠 Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgment](#Acknowledgment)
- [📜 License](#license)

## 📖 About the Project

Welcome to 4Budget, your personal finance management application built with Ruby on Rails. This app helps you manage your expenses efficiently by organizing transactions into categories and providing insightful financial data. Keep track of your spending, create new categories, and add transactions with ease.

This project is inspired by the original design idea by Gregoire Vella on Behance, and it is used under the Creative Commons license.

## 🛠 Built With

### Tech Stack

#### Client
- HTML5
- CSS3
- Boostrap

#### Server
- Ruby on Rails

#### Database
- PostgreSQL

### Key Features

- **Intuitive Expense Tracking:** Easily track and categorize your expenses, providing a clear overview of your financial health.
- **Custom Categories:** Create custom spending categories tailored to your unique financial habits.
- **Insightful Data:** Get a clear picture of your spending habits with insightful data and visualizations.

## 💻 Live Demo

- Live-Demo: [4Budget](https://budget-app-y2fh.onrender.com)

## 📸 Screenshots

![Alt text](image.png)
![Alt text](image-1.png)
![Alt text](image-2.png)
![Alt text](image-3.png)

## 💻 Getting Started

### 🛠 Setup

1. **Clone the Project Repository:**

```bash
git clone https://github.com/PabloBona/budget.git
```

2. **Navigate to the Project Folder:**

```bash
cd budget
```

### Prerequisites

Before you can run 4Budget, ensure you have the following prerequisites and configurations in place:

- **Ruby**: Verify that Ruby is installed on your machine by running `ruby -v` in your terminal. If not, download and install Ruby from the [official Ruby website](https://www.ruby-lang.org/en/documentation/installation/).

- **Ruby on Rails**: Install the Ruby on Rails framework using the following command if you haven't already:

```bash
gem install rails
```

- **Code Editor**: Use a code editor like Visual Studio Code (VSCode). If you don't have it, download it from the [official website](https://code.visualstudio.com/).

- **Git**: Make sure Git is installed and configured for version control. Download Git from the [official Git website](https://git-scm.com/downloads).

- **PostgreSQL**: Install and properly configure PostgreSQL on your development server. 4Budget assumes the use of PostgreSQL as the default database. Download PostgreSQL from the [official PostgreSQL website](https://www.postgresql.org/download/).

- **Ruby on Rails Configuration**: Configure your Ruby on Rails project to use PostgreSQL as the default database.

With these prerequisites and configurations in place, you're ready to set up and run 4Budget.

### 📖 Usage

Follow these steps to use 4Budget:

1. **Open your Terminal:**

Navigate to the directory where the project files are located:

```bash
cd /path/to/your/project/files
```

2. **Start the Rails Server:**

```bash
rails server
```

3. **Access 4Budget:**

Open your web browser and go to [http://localhost:3000](http://localhost:3000) to access 4Budget and manage your personal finances efficiently.

## 👥 Authors

👤 **Pablo Bonasera**
- GitHub: [@PabloBona](https://github.com/PabloBona)
- LinkedIn: [Pablo Bonasera](https://www.linkedin.com/in/pablo-bonasera/)

## 🔭 Future Features

We are committed to continuous improvement and plan to implement the following features in future updates:

- **Budgeting Tool:** Introduce a comprehensive budgeting tool that allows users to set monthly budgets for different expense categories. The app will provide notifications and insights to help users stay within their budget limits.

- **Expense Insights:** Enhance the analytics section with more detailed insights. Users will be able to visualize their spending trends over time, compare expenses across different categories, and receive personalized suggestions for optimizing their budget.

- **Multi-Platform Support:** Extend 4Budget's accessibility by developing mobile applications for both Android and iOS platforms. This will enable users to manage their finances seamlessly on their smartphones and tablets, providing a consistent experience across devices.

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

## ⭐️ Show your support

Give a ⭐️ if you like this project!

## 🙏 Acknowledgment

We would like to express our deepest gratitude to [Gregoire Vella](https://www.behance.net/gregoirevella) on Behance for her Original design [idea](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=).

## 📜 License

This project is licensed under the [MIT License](https://github.com/PabloBona/budget/blob/dev/MIT.md) as required by the original design idea by Gregoire Vella on Behance under the Creative Commons license.