Installation

Requirements

Server Requirements

• PHP: 8.2 or higher
• Composer: Latest version
• Node.js: 18+ (for asset compilation)
• Database: MySQL 8.0+ or PostgreSQL 13+
• Redis: 6.0+ (optional, for caching)

PHP Extensions

• BCMath PHP Extension
• Ctype PHP Extension
• cURL PHP Extension
• DOM PHP Extension
• Fileinfo PHP Extension
• JSON PHP Extension
• Mbstring PHP Extension
• OpenSSL PHP Extension
• PCRE PHP Extension
• PDO PHP Extension
• Tokenizer PHP Extension
• XML PHP Extension

Installation Steps

1. Clone the Repository

git clone https://github.com/RattsTechServices/zafira.git
cd zafira

2. Install Dependencies

composer install
npm install

3. Environment Setup

cp .env.example .env
php artisan key:generate

4. Configure Environment

Edit your .env file with the following configurations:

Database Configuration (for Laravel Sail)

DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=sail
DB_PASSWORD=password

Database Configuration (for Local Installation)

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=zafira
DB_USERNAME=your_username
DB_PASSWORD=your_password

Application Configuration

APP_NAME=Zafira
APP_ENV=local
APP_DEBUG=true
APP_PORT=3300
APP_URL=http://localhost:3300

# For Laravel Sail
FORWARD_DB_PORT=3307
FORWARD_REDIS_PORT=6380

Cryptography Configuration

CRYPTOGRAPH_STORAGE=file
CRYPTOGRAPH_NAME=zafira_cryptograph_key
ETHERSCAN_API_KEY=your_etherscan_api_key_here

5. Run Migrations and Seed Database

# Run migrations to create database tables
php artisan migrate

# Seed database with initial data (users, networks, wallets)
php artisan db:seed

6. Build Assets

npm run build

7. Start the Application

Option A: Using PHP Artisan Serve

php artisan serve --port=3300

Option B: Using Laravel Sail (Docker)

# Start all services
./vendor/bin/sail up -d

# Or use the alias (if configured)
sail up -d

8. Access the Application

With PHP Artisan Serve:

• Application: http://localhost:3300
• API Documentation: Available at /api/documentation

With Laravel Sail:

• Application: http://localhost:3300
• API Documentation: Available at /api/documentation
• Database: localhost:3307 (MySQL - forwarded port)
• Redis: localhost:6380 (Redis - forwarded port)

Default Users

After running php artisan db:seed, the following users are created:

Root User (Super Admin)

• Email: root@local.com
• Password: root@2025
• Role: root (Super administrator with all permissions)

Admin User

• Email: admin@local.com
• Password: admin@2025
• Role: admin (Administrator with full system access)

Security Note

These are the default credentials for initial access. Please change them after first login for security.

Next Steps

• Configuration - Configure your Zafira installation
• API Overview - Learn about the API endpoints
• Webhook System - Configure webhook notifications