EzFin Documentation

Everything you need to know to get the most out of EzFin.

Getting Started

Welcome to EzFin! This guide will help you get started with managing your finances.

Installation

Follow these steps to set up EzFin on your system.

# Clone the repository
git clone https://github.com/yourusername/ezfin.git

# Install dependencies
cd ezfin
composer install
npm install

# Setup environment
cp .env.example .env
php artisan key:generate

# Run migrations
php artisan migrate --seed

# Build assets
npm run build

First Steps

Once installed, follow these steps to get started:

1. Create your account and set up your profile
2. Add your bank accounts and credit cards
3. Start tracking your transactions
4. Set up budgets and financial goals

Features

EzFin offers a comprehensive set of features to help you manage your finances.

Accounts

Manage different types of accounts:

• Checking accounts
• Savings accounts
• Credit cards
• Investment accounts

Transactions

Track and categorize all your financial transactions with ease.

Budgets

Create and monitor budgets to stay on track with your financial goals.

Reports

Generate detailed reports to understand your financial patterns.

API Reference

EzFin provides a RESTful API for developers.

Authentication

All API requests require authentication using Bearer tokens.

// Example API authentication
const response = await fetch('/api/login', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    },
    body: JSON.stringify({
        email: 'user@example.com',
        password: 'password'
    })
});

const data = await response.json();
const token = data.token;

Endpoints

Available API endpoints:

Method	Endpoint	Description
GET	/api/accounts	Get all accounts
POST	/api/accounts	Create new account
GET	/api/transactions	Get all transactions
POST	/api/transactions	Create new transaction