This manual covers daily operations for each staff role. Use the table of contents to jump to your section.
The simplest way to run the application is via Docker — no software installation required beyond Docker itself.
# Start the application
docker compose up -d
# The app is now available at http://localhost:8000On first launch, the system automatically sets up the database and creates the default admin account. See the README for more Docker commands and configuration options.
- Open the bank portal in your browser (
http://localhost:8000if running via Docker) - Enter your registered Email and Password
- Click Login
- You will be redirected to your role-specific dashboard
Click your name in the top-right corner and select Logout, or click the logout button in the sidebar.
Contact your Manager or SuperAdmin to reset your password — self-service password reset must be configured by your system administrator.
The SuperAdmin role has full access to system configuration. These settings affect all branches.
Path: SuperAdmin > Company Setup
Set the bank's name, contact details, and tax registration numbers. This information appears on printed receipts and reports.
- Navigate to Company Setup
- Fill in: Company Name, Address, Phone, Email, Website, GST No., PAN No.
- Optionally upload a logo
- Click Save Settings
Path: SuperAdmin > Branches
| Action | Steps |
|---|---|
| Add branch | Click New Branch → fill name, code, address, opening date → Save |
| Edit branch | Click Edit next to the branch |
| Deactivate | Toggle the Active switch |
Path: SuperAdmin > Users
- Click New User
- Enter name, email, and assign a Role and Branch
- Set a temporary password (user should change on first login)
- Click Save
Roles available: SuperAdmin, Manager, Clerk, Cashier, Accountant
Path: SuperAdmin > Loan Types
Define the loan products offered by the bank (e.g., Personal Loan, Home Loan, Agriculture Loan).
Fields:
- Name — product name
- Interest Rate — annual rate (%)
- Duration — in months
- Max Amount — maximum loan amount
- No. of Installments — total installment count
- Frequency — Monthly, Quarterly, or Yearly
- Description — optional notes
Path: SuperAdmin > FD Setup
Configure Fixed Deposit schemes:
- Description — scheme description
- Duration — in days
- Interest Rate — annual rate (%)
- Senior Citizen — toggle for senior citizen scheme
- Special ROI — toggle for special rate of interest
Path: SuperAdmin > Account Types
Define savings, current, and OD account types:
- Name — display name
- Type — Savings, Current, or Overdraft (OD)
- Minimum Balance — required minimum balance
- Interest Rate — annual rate (%)
Path: SuperAdmin > Task Scheduler
View and manage all scheduled background tasks:
- Enable/Disable — pause or resume any task
- Edit Schedule — change the frequency (every 5 min, hourly, daily at specific time, weekly, monthly)
- Run Now — execute a task immediately with one click
- View Logs — see run history with status, duration, and who triggered it
Default tasks include: FD maturity processing, OD interest calculation, queue drain, overdue EMI reminders, upcoming EMI alerts, audit log cleanup, and daily transaction reports.
Path: SuperAdmin > Queue Monitor
Monitor background job processing:
- Pending Jobs — see all jobs waiting to be processed, with job name, queue, and attempts
- Failed Jobs — view failed jobs with error details
- Retry — retry a specific failed job or all failed jobs at once
- Delete — remove a failed job or clear all
- Process Now — drain the entire queue immediately
- Queue Breakdown — see job count per queue (default, notifications)
Managers oversee a branch. They approve customers and loans, and open accounts.
The Manager dashboard shows:
- Pending customer approvals
- Pending loan applications
- Branch-level account and loan counts
Clerks register customers, but Managers must approve them before they can transact.
Path: Manager > Customers
- Click on a customer name to view their details and KYC documents
- Verify PAN and Aadhaar documents
- Click Approve or Reject
- If rejecting, provide a reason
- The customer receives an email/SMS notification
Accounts can only be opened for approved customers.
Path: Manager > Bank Accounts > New Account
- Select the Customer (search by name or customer ID)
- Choose Account Type (Savings, Current, OD)
- Enter the Opening Balance
- Click Open Account
The system generates a unique account number automatically.
Path: Manager > FD Accounts > New FD
- Select the Customer
- Choose the FD Scheme
- Enter the Principal Amount and Tenure
- Confirm the calculated maturity amount and date
- Click Open FD
Path: Manager > Loan Applications
- Click on an application to review it
- Check customer details, income, guarantor, and requested amount
- Click Approve (enter sanctioned amount) or Reject (with reason)
After approval, the Manager disburses the loan:
Path: Manager > Loans > Disburse
- Select the approved loan application
- Confirm disbursement amount and account to credit
- Click Disburse
The system generates the full EMI installment schedule automatically.
Path: Manager > Loans > {Loan} > Schedule
Shows all EMI dates, principal, interest, and outstanding balance per installment.
Clerks handle front-office data entry: customer registration and loan applications.
Path: Clerk > Customers > New Customer
Fill in all sections:
Personal Information
- Full name (as per ID)
- Date of birth
- Gender
- Occupation
Contact Details
- Mobile number (used for SMS notifications)
- Email address
- Emergency contact
Address
- Current and permanent address
- Country / State / City (select from dropdown)
- PIN code
KYC Documents
- PAN number + upload scanned copy (JPG/PNG/PDF, max 2MB)
- Aadhaar number + upload scanned copy (JPG/PNG/PDF, max 2MB)
Nominee Details
- Nominee name, relationship, date of birth
Click Register Customer. The application goes to the Manager for approval.
Path: Clerk > Customers
The list shows all customers registered by your branch. Status badges:
- Pending — awaiting Manager approval
- Approved — active, can open accounts
- Rejected — application rejected, requires re-submission
Click View to see full details.
Only approved customers can apply for loans.
Path: Clerk > Loan Applications > New Application
- Select the Customer (search by name or ID)
- Choose Loan Type
- Enter Requested Amount and Tenure (months)
- Enter Purpose of Loan
- Add Guarantor details (if required by loan type)
- Upload supporting documents (income proof, property documents, etc.)
- Click Submit Application
The application moves to the Manager queue for review.
Path: Clerk > Loan Applications
Shows all applications submitted by your branch. Statuses:
- Submitted — pending Manager review
- Approved — sanctioned, pending disbursement
- Rejected — application declined
- Disbursed — loan active
Cashiers process all financial transactions at the counter.
Shows today's transaction summary:
- Total deposits
- Total withdrawals
- Total loan repayments collected
- Number of transactions
Path: Cashier > Transactions > New Transaction
- Search Account — enter the account number and press Enter or click Search
- The customer name and current balance appear automatically
- Select Transaction Type: Deposit or Withdrawal
- Enter Amount
- Select Payment Mode: Cash or Cheque
- If Cheque is selected, enter cheque number, bank, and date
- Enter Remarks (optional)
- Click Submit Transaction
A confirmation slip is displayed. Print or save it for the customer.
Note: Withdrawals are blocked if the account balance would fall below the minimum balance defined for the account type.
Path: Cashier > Loan Repayments > New Repayment
- Enter the Loan Account Number and press Search
- The current EMI due, outstanding balance, and overdue amount are shown
- Enter the Amount Collected
- Select Payment Mode
- Click Record Repayment
The system automatically marks the corresponding installment(s) as paid and updates the outstanding balance.
Path: Cashier > Transactions
Filter by date range, account number, or transaction type.
Accountants have read-only access and generate financial reports.
Overview of the branch's financial position:
- Total loan outstanding
- This month's collection
- Overdue loans count and amount
- Active FD count and value
Path: Accountant > Reports > Loan Outstanding
Shows all active loans with:
- Customer name and loan ID
- Loan type and sanctioned amount
- Total paid, outstanding principal, outstanding interest
- Days overdue (if any)
Export: Click Download CSV or Print for a formatted report.
Filter by:
- Loan type
- Date range (disbursement date)
- Overdue only toggle
Path: Accountant > Reports > Transaction Statement
Generates a full debit/credit statement for any account.
- Enter the Account Number
- Select Date Range
- Click Generate
The statement shows every transaction with date, description, debit/credit, and running balance.
Export: Download as CSV or print as PDF.
Path: Accountant > Reports > Loan Demand
Shows the EMI schedule vs actual collections for a date range:
- Which installments were due
- Which were paid (and when)
- Which are overdue
Used for daily collection monitoring and overdue follow-up.
From any screen that has a customer lookup field:
- Type the customer's name, mobile number, or customer ID
- The autocomplete shows matching results
- Click to select
After any transaction or account opening:
- A confirmation screen appears with the transaction reference number
- Click Print Receipt to open the browser print dialog
- Or click Download PDF (if configured)
The bell icon in the top navigation bar shows recent system notifications (approvals, rejections, FD maturities, etc.). Click to mark as read.
You do not have permission for that page. Confirm with your Manager or SuperAdmin that your role is set correctly.
The transaction may be processing in the background queue. Refresh the page after a few seconds. If the balance is still wrong after 5 minutes, contact your system administrator.
The customer may be in Pending status (not yet approved). Check with the Manager to approve the customer first.
Ensure the file:
- Is JPG, PNG, or PDF format
- Is under 2 MB in size
- Is not password-protected (for PDFs)
The account balance after the withdrawal would fall below the minimum balance. Either:
- Reduce the withdrawal amount
- Ask the Manager to adjust the minimum balance rule for the account
If you are inactive for an extended period, your session will expire for security. Log in again — your data is saved.
If the application is not loading after docker compose up -d:
- Check container logs:
docker compose logs -f app - Verify the container is running:
docker compose ps - If the database is corrupted, reset it:
docker compose down -v && docker compose up -d
Contact your branch Manager or the system administrator. For technical issues, report them via the project GitHub repository.