Platform Guides

Learn how to explore the FinAegis platform and contribute to our open-source project.

Popular Guides

Start with these essential guides to get up and running

Getting Started

Platform overview

Development Setup

Contributing to the project

Testing Features

Exploring demo functionality

Providing Feedback

Reporting issues & suggestions

Getting Started

Understanding the FinAegis platform and how to explore it

About the Sandbox

The public FinAegis instance runs in sandbox mode, which means:

  • All transactions and balances use test data (no real money)
  • Every feature is available for you to explore
  • New features are added regularly as the platform evolves
  • Your feedback helps shape the platform

Note: The sandbox uses test data only. No real financial transactions are processed in this environment.

Creating Your Test Account

Follow these steps to create your account:

  1. Click "Register" on the homepage
  2. Use a test email address (can be your real email)
  3. Create a password (this is for testing only)
  4. Explore the dashboard with sandbox data

Note: No real identity verification is required for the sandbox.

Available Features

Available to explore in the sandbox:

  • User registration and authentication
  • Dashboard with simulated account data
  • GCU concept demonstration
  • Basic API endpoints (12 endpoints)
  • Admin panel (for authorized testers)

Development Setup

Contributing to the FinAegis open source project

Local Development Environment

Set up FinAegis locally for development:

# Clone the repository

git clone https://github.com/FinAegis/core-banking-prototype-laravel.git

cd core-banking-prototype-laravel


# Install dependencies

composer install

npm install


# Configure environment

cp .env.example .env

php artisan key:generate


# Run migrations

php artisan migrate


# Start development server

php artisan serve

Tech Stack Overview

FinAegis is built with:

Backend

  • • Laravel (PHP framework)
  • • MySQL/PostgreSQL
  • • Redis for queues
  • • Laravel Sanctum for API auth

Frontend

  • • Blade templates
  • • Tailwind CSS
  • • Alpine.js
  • • Laravel Livewire

Contributing Guidelines

How to contribute to FinAegis:

  1. Fork the repository on GitHub
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Make your changes and test thoroughly
  4. Run tests (./vendor/bin/pest)
  5. Commit with clear messages
  6. Push to your fork and create a pull request

Testing Platform Features

How to test and explore the demo functionality

Simulated Transactions

Testing transaction flows:

  • All balances are simulated (starting with demo funds)
  • Transactions don't involve real money or banks
  • Currency conversions use demo exchange rates
  • Transaction history is for demonstration only

Feel free to test all transaction types without worry - nothing is real!

API Testing

Testing the REST API:

  1. Register for an account to get API access
  2. Use the API documentation at /developers/api-docs
  3. Test with tools like Postman or curl
  4. All API responses use simulated data

# Example API call

curl -X GET http://localhost:8000/api/v1/accounts \

-H "Authorization: Bearer YOUR_TOKEN"

GCU Demo Features

Exploring the Global Currency Unit concept:

  • View the current GCU composition (demonstration values)
  • See how democratic voting will work (UI preview only)
  • Test currency conversion with GCU
  • Understand the multi-currency basket concept

Note: Voting functionality is available in sandbox mode. Production governance cycles are planned for a future release.

Providing Feedback

Help us improve FinAegis with your feedback

Reporting Bugs

Found a bug? Here's how to report it:

  1. Check if the issue already exists on GitHub
  2. Create a new issue with a clear title
  3. Provide steps to reproduce the bug
  4. Include error messages or screenshots
  5. Mention your environment (OS, browser, etc.)
Create Bug Report →

Feature Requests

Have an idea for a new feature?

  • Check our roadmap to see if it's planned
  • Create a GitHub issue with [Feature Request] tag
  • Describe the feature and its benefits
  • Provide use cases and examples
  • Join the discussion on existing requests

Community Discussion

Join our community:

  • GitHub Discussions for general topics
  • Email support@zelta.app for direct feedback
  • Star the repository to show support
  • Share the project with other developers
Join Discussions → Email Feedback →

Need More Help?

Can't find what you're looking for? Check out these additional resources.

Browse FAQ Contact Support