https://github.com/alierpm/budgeti
https://github.com/alierpm/budgeti
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alierpm/budgeti
- Owner: AlierPM
- License: mit
- Created: 2024-02-19T12:25:29.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-02-24T20:42:00.000Z (over 1 year ago)
- Last Synced: 2025-02-04T13:44:14.446Z (4 months ago)
- Language: Ruby
- Size: 1.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
💰 Budgeti
Your personal budget management app!
# 📗 Table of Contents
- [📖 About Budgeti](#about-budgeti)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run Project](#run-project)
- [Run Tests](#run-tests)
- [👥 Contributors](#contributors)
- [🔍 Future features?](#future-features)
- [🤝 Let's Collaborate](#lets-collaborate)
- [⭐️ Star It](#star-it)
- [🙏 Acknowledgments](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
Welcome to Budgeti, your go-to app for managing personal finances. Take control of your budget, track expenses, and plan for financial success.
Backend
Frontend
Database
- **User Authentication:** Securely log in and register with Devise.
- **Expense Tracking:** Record and manage your expenses effortlessly.
- **Category Management:** Categorize your expenses for better insights.
### Live Demo & Features presentation
[Check out the Live Demo](https://budgeti-nl4j.onrender.com/)
[check out the features presentation here](https://www.loom.com/share/cfc94d0344e14b339ab7a6cb9e111d1d?sid=e688e735-b201-414d-877d-e097edafe1bb)
> The following steps will guide you in setting up and running Budgeti:
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/AlierPM/Budgeti.git
```
### Prerequisites
In order to run this project, you need:
1. Ruby installed:
- On macOS using Homebrew:
```sh
brew install ruby
```
- On Windows or Linux, follow the installation instructions from [Ruby's official website](https://www.ruby-lang.org/en/documentation/installation/).
2. Rails Installed:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/AlierPM/Budgeti.git
```
### Install
Navigate to the Budgeti directory:
```sh
cd Budgeti
```
### Usage
Open the project in your preferred code editor:
```sh
cd Budgeti
code .
```
### Run project
To run from the local server, execute the following command:
```sh
rails server
```
### Run tests
To run tests, execute the following command:
```sh
rpec spec
```
👥 Contributors
Meet the masterminds behind Budgeti.
👩💻 Finance Guru
👤 **Alier Philip Maguet**
- GitHub: [@AlierPM](https://github.com/AlierPM)
- Twitter: [@AlierPM](https://twitter.com/AlierPM)
- LinkedIn: [@AlierPM](https://www.linkedin.com/in/alierphilipmaguet/)
## 🔍 Future features?
Budgeti is always evolving. Here's a taste of what's cooking next:
- [ ] **Expense Categories**
- [ ] **Monthly Reports**
- [ ] **Integration with Financial APIs**
Join the recipe revolution! Contribute to Recipedaily by:
- Reporting Bugs
- Adding Features
- Enhancing Documentation
Feel free to check the [issues page](../../issues/) for ongoing discussions.
## ⭐️ Star It
> If you find Budgeti helpful, show your support by starring the repository. It adds a dash of motivation to our financial journey!
> A big thank you to everyone who contributed to the development of Budgeti.
- Special thanks to Microverse for providing an exceptional collaborative learning environment and making this project possible.
- Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding).
- **Q: How do I track my expenses?**
- A: Log in, head to your dashboard, and click on the "Track Expenses" button.
- **Q: Can I set a monthly budget?**
- A: Absolutely! Visit the "Budgets" section to set and manage your financial goals.
This project is [MIT](./License) licensed. We invite you to cook up your own creative ideas using our recipe.