CuanKu

Smart Personal Finance Management Platform
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Features
5. Roadmap
6. Contributing
7. License
8. Contact

About The Project

Project Folder Structure

cuanku/
├── app/
│   ├── Constants/
│   ├── Enums/
│   ├── Filament/
│   ├── Helpers/
│   ├── Http/
│   │   ├── Controllers/
│   │   ├── Middleware/
│   │   ├── Requests/
│   │   ├── Resources/
│   ├── Models/
│   ├── Observers/
│   ├── Policies/
│   ├── Providers/
│   ├── Traits/
├── bootstrap/
├── config/
├── database/
│   ├── factories/
│   ├── migrations/
│   ├── seeders/
├── public/
│   ├── build/
│   ├── css/
│   ├── images/
│   ├── js/
├── resources/
│   ├── css/
│   ├── js/
│   ├── views/
├── routes/
│   ├── auth.php
│   ├── console.php
│   ├── web.php
├── storage/
│   ├── app/
│   ├── framework/
│   ├── logs/
├── tests/
│   ├── Feature/
│   ├── Unit/
├── vendor/
├── artisan
├── composer.json
├── package.json
├── README.md
├── ...

CuanKu is a comprehensive personal finance management platform designed to help individuals take control of their financial lives. With intelligent features and an intuitive interface, CuanKu empowers users to track expenses, manage budgets, set financial goals, and make informed financial decisions.

Key Highlights:

• 🎯 Smart Budget Management - Create and track budgets with real-time monitoring
• 📊 Expense Tracking - Categorize and analyze your spending patterns
• 🎯 Goal Setting - Set and achieve your financial objectives
• 📈 Net Worth Tracking - Monitor your assets and liabilities
• 💰 Savings Reminders - Automated notifications to encourage regular saving habits
• 🤖 AI-Powered Insights - Get personalized financial recommendations powered by n8n automation
• 📧 Automated Reports - Monthly/yearly financial summaries sent via intelligent workflows
• 📱 Modern UI/UX - Beautiful and responsive design across all devices
• 🔧 Admin Dashboard - Elegant admin panel built with Filament for user management
• 🔍 Error Monitoring - Real-time error tracking and performance monitoring with Sentry

(back to top)

Built With

This project is built using modern web technologies:

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

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

Prerequisites

Make sure you have the following installed:

• PHP >= 8.1
• Composer
• Node.js >= 16
• MySQL >= 8.0
• MongoDB >= 6.0
• n8n (for AI automation workflows)
• Metabase (for business analytics)
• Filament (for admin dashboard)
• Sentry (for error tracking and monitoring)
• Git

Installation

1. Clone the repository

   git clone https://github.com/titanioy/cuanku.git

2. Navigate to the project directory

   cd cuanku

3. Install PHP dependencies

   composer install

4. Install NPM packages

   npm install

5. Copy the environment file

   cp .env.example .env

6. Generate application key

   php artisan key:generate

7. Configure your database in .env file

   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=cuanku
   DB_USERNAME=your_username
   DB_PASSWORD=your_password
   
   # Sentry Configuration (optional)
   SENTRY_LARAVEL_DSN=your_sentry_dsn_here
   SENTRY_TRACES_SAMPLE_RATE=1.0
   

8. Run database migrations

   php artisan migrate

9. Seed the database (optional)

   php artisan db:seed

10. Build frontend assets

    npm run build

11. Start the development server

    php artisan serve

12. Configure Sentry for error tracking (optional)

    • Sign up for a free account at Sentry.io
    • Create a new Laravel project
    • Copy your DSN and add it to your .env file
    • Install Sentry SDK:

    composer require sentry/sentry-laravel

(back to top)

Usage

Dashboard Overview

Access your financial overview with real-time data visualization including:

• Monthly income vs expenses
• Budget performance
• Goal progress tracking
• Net worth evolution

Budget Management

• Create monthly budgets by category
• Track spending against budget limits
• Receive alerts when approaching limits
• Analyze budget performance over time

Expense Tracking

• Log expenses with detailed categorization
• Upload receipts and notes
• Generate expense reports
• Identify spending patterns

Report Tracking & PDF Download

• View monthly financial tracking reports with month/year filter
• See cash flow summary, budget overview, income & expense tracking in one place
• Download Report Tracking as a professionally formatted PDF
• Includes detailed breakdowns of income, expenses, and budget performance
• Download PDF with a single click

Financial Goals

• Set short-term and long-term financial goals
• Track progress with visual indicators
• Receive milestone notifications
• Adjust goals as needed

Business Analytics Dashboard (Metabase)

• Access comprehensive business intelligence dashboards
• Monitor user engagement and platform performance
• Analyze financial trends and user behavior patterns
• Generate custom reports for stakeholder insights
• Real-time metrics visualization for business decisions

Admin Dashboard (Filament)

• Access admin panel at /admin route
• Manage user accounts and permissions
• View user statistics and activity
• Clean and intuitive interface for user management
• Built with Filament for Laravel administration

API Documentation (Swagger)

• Access API documentation at /api/documentation route
• Explore and test all available API endpoints
• Built with L5-Swagger for OpenAPI specification
• Real-time interaction with the Cuanku backend API

Annual Reports & PDF Export

• Generate comprehensive annual financial reports
• Download reports in PDF format with professional styling
• Include monthly breakdowns for all financial categories
• Automated calculations for planned vs actual comparisons
• Shareable reports for financial planning and analysis

For more examples, please refer to the Documentation

(back to top)

Features

• User Authentication & Authorization
• Budget Creation & Management
• Expense & Income Tracking
• Financial Goal Setting
• Net Worth Calculation
• Dashboard Analytics
• Monthly/Yearly Financial Reports
• PDF Export for Annual Reports
• Admin Panel (Filament)
• API Documentation (Swagger)
• Responsive Design
• AI-Powered Financial Insights
• Business Analytics Dashboard (Metabase)
• Mobile App
• Bank Integration
• Investment Tracking
• Bill Reminders

(back to top)

Roadmap

• Add mobile application
• Implement AI-powered financial advisor
• Add bank account integration
• Multi-language Support
• Investment portfolio tracking
• Automated bill reminders
• Financial planning tools

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feat/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Titanio Yudista - titanio.yudista@cakrawala.ac.id

Project Link: https://github.com/titanioy/cuanku

(back to top)