Alpha Platform Guides
Learn how to explore the FinAegis alpha platform and contribute to our open source project.
Popular Guides
Start with these essential guides for alpha testing
Getting Started with Alpha Testing
Understanding the FinAegis alpha platform and its current state
What is Alpha Testing?
The FinAegis platform is currently in alpha testing phase, which means:
- All transactions and balances are simulated (no real money)
- Features are being actively developed and may change
- Some functionality may be incomplete or unstable
- Your feedback helps shape the platform
Important: Do not attempt to use real financial information or expect real transactions during alpha testing.
Creating Your Test Account
Follow these steps to create an alpha testing account:
- Click "Register" on the homepage
- Use a test email address (can be your real email)
- Create a password (this is for testing only)
- Explore the demo dashboard with simulated data
Note: No real identity verification is required during alpha testing.
Available Features in Alpha
Currently available for testing:
- 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:
- Fork the repository on GitHub
- Create a feature branch (
git checkout -b feature/your-feature
) - Make your changes and test thoroughly
- Run tests (
./vendor/bin/pest
) - Commit with clear messages
- 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:
- Register for an account to get API access
- Use the API documentation at
/developers/api-docs
- Test with tools like Postman or curl
- 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: Actual voting functionality will be implemented in beta phase.
Providing Feedback
Help us improve FinAegis with your feedback
Reporting Bugs
Found a bug? Here's how to report it:
- Check if the issue already exists on GitHub
- Create a new issue with a clear title
- Provide steps to reproduce the bug
- Include error messages or screenshots
- Mention your environment (OS, browser, etc.)
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 [email protected] for direct feedback
- Star the repository to show support
- Share the project with other developers
Need More Help?
Can't find what you're looking for? Check out these additional resources.