Skip to content

Take control of your finances and create a budget that works for you.

Notifications You must be signed in to change notification settings

AimanK/fund-forecast

Repository files navigation

💸 Fund Forecast

Fund Forecast is a full-stack Ruby on Rails budgeting app that helps you take control of your finances. Create monthly budgets 🗓️, track your income and expenses 📊 in an itemized, customizable way, and view previous budgets to analyze spending habits over time. Our goal is to help you forecast your finances and make smarter financial decisions!

✨ Features

  • Create Monthly Budgets: Set up your monthly budget 📝 by entering your income and customizing expense categories to fit your unique needs.
  • Track Income and Expenses: Stay organized by tracking all your income and expenses 💰 in an easy-to-read, itemized format.
  • View Previous Budgets: Access your previous budgets 🔄 to compare spending trends and make informed decisions for the future.
  • Customizable Categories: Modify expense categories 🛠️ based on your personal spending habits, whether for groceries 🛒, rent 🏠, or entertainment 🎉.
  • Visual Data Analysis: (Future feature) Leverage charts 📈 and graphs 📊 to visualize spending habits and forecast your financial future with ease.

📸 Screenshots

Screenshot 2024-10-03 at 8 09 49 PM

🛠️ Technologies Used

  • Backend: Ruby on Rails 🛤️
  • Frontend: Tailwind CSS 💅 for clean, responsive styling
  • Authentication: Devise 🔐 for user authentication
  • Database: PostgreSQL 🗄️ for data management
  • Deployed on: (e.g., Heroku 🚀, AWS ☁️)

🚀 Installation and Setup

Prerequisites

  • Ruby 3.3.0 or higher 💎
  • Rails 7.2.1 or higher 🚂
  • PostgreSQL 🐘

Steps

  1. Clone the repository:
    git clone https://github.com/your-username/fund-forecast.git
    cd fund-forecast
  2. Install dependencies:
bundle install
  1. Set up the database:
rails db:create
rails db:migrate
  1. Start the rails server:
rails server
  1. Visit http://localhost:3000 to access the app locally 🌐.

Tailwind CSS

For frontend development, start Tailwind's watch command to automatically compile your styles:

./bin/dev

💡 Usage

Once signed in:

  • Create a new budget 📝 to manage your finances.
  • Itemize income and expenses 💸.
  • Track past budgets 🕑 to analyze your financial trends.
  • Use the data to forecast your spending 🔮 and plan ahead.

🤝 Contributing

  • Contributions are welcome! 🎉 If you'd like to contribute, please follow these steps:

Fork the repository 🪝.

  • Create a new feature branch
    (git checkout -b feature/new-feature).
  • Commit your changes
    (git commit -m 'Add a new feature').
  • Push to the branch
    (git push origin feature/new-feature).
  • Submit a pull request 🛠️.

About

Take control of your finances and create a budget that works for you.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published