⬡ CryptoMax

⚙ Requirements

🚀 Installation

CryptoMax ships as a complete package including all dependencies. No need to run Composer — just follow the steps below.

Package Contents

After purchasing and downloading, your package will contain the following:

cryptomax/
                    ├── app/
                    ├── public/
                    ├── vendor/
                    ├── writable/
                    ├── composer.json
                    └── composer.lock

Recommended Directory Structure

Following CodeIgniter 4 security best practices, it is strongly recommended to place most of the application outside your web root (public_html), and only expose the contents of the public/ folder. This prevents direct web access to your app/ and vendor/ folders.

your-server/
                    ├── public_html/ ← Web root (contents of public/ go here)
                    │ ├── index.php
                    │ ├── .htaccess
                    │ └── assets/
                    ├── app/ ← Outside public_html
                    ├── vendor/ ← Outside public_html
                    ├── writable/ ← Outside public_html
                    ├── composer.json
                    └── composer.lock

Installation Steps

chmod -R 755 writable/
                                chmod -R 755 public_html/uploads/

https://yourdomain.com/install.php

Reinstallation

Once installed, the installer will no longer be detected on normal site visits. However, if you made a mistake during installation or need to start over, you can run the installer directly:

https://yourdomain.com/install.php

It will prompt you to confirm the reinstallation. Click OK to continue.

🔧 Environment Configuration

Application

.envCI_ENVIRONMENT = development
                    app.baseURL = 'https://yourdomain.com/'
                    app.siteName = 'CryptoMax'
                    app.pin = 1234

Database

.envdatabase.default.hostname = localhost
                    database.default.DBDriver = MySQLi
                    database.default.database = cryptomax
                    database.default.username = cryptomax_user
                    database.default.password = your_password
                    database.default.DBPrefix = kis_
                    database.default.charset = utf8mb4
                    database.default.DBCollat = utf8mb4_general_ci

Encryption Key

.envencryption.key = hex2bin:YOUR_32_BYTE_HEX_KEY

Generate a secure key with: php spark key:generate

🗄 Database Setup

The setup wizard handles all migrations automatically. To run manually:

bashphp spark migrate
                    php spark db:seed AssetsSeeder
                    php spark db:seed EmailtemplatesSeeder
                    php spark db:seed FaqsSeeder
                    php spark db:seed ReviewsSeeder

🌐 Web Server Configuration

Apache

apache<VirtualHost *:80>
                    ServerName yourdomain.com
                    DocumentRoot /var/www/html/cryptomax/public
                    <Directory /var/www/html/cryptomax/public>
                    AllowOverride All
                    Require all granted
                    </Directory>
                    </VirtualHost>

Nginx

nginxserver {
                    listen 80;
                    server_name yourdomain.com;
                    root /var/www/html/cryptomax/public;
                    index index.php;
                    location / { try_files $uri $uri/ /index.php$is_args$args; }
                    location ~ \.php$ {
                    fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;
                    fastcgi_index index.php;
                    include fastcgi_params;
                    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
                    }
                    }

🔑 Google OAuth Setup

📧 Email (SMTP) Setup

.envemail.protocol = smtp
                    email.SMTPHost = smtp.mailprovider.com
                    email.SMTPPort = 587
                    email.SMTPCrypto = tls
                    email.SMTPUser = [email protected]
                    email.SMTPPass = your_password
                    email.fromEmail = [email protected]
                    email.fromName = CryptoMax

All transactional emails are fully customisable from Admin → Email Templates. Includes 15 templates covering registration, deposits, withdrawals, KYC, 2FA, password reset, and more.

🔔 Web Push Notifications

Generate VAPID keys and add them to your .env:

bashphp -r "
                    \$keys = \Minishlink\WebPush\VAPID::createVapidKeys();
                    echo 'Public: ' . \$keys['publicKey'] . PHP_EOL;
                    echo 'Private: ' . \$keys['privateKey'] . PHP_EOL;
                    "

.envvapid.publickey = YOUR_PUBLIC_VAPID_KEY
                    vapid.privatekey = YOUR_PRIVATE_VAPID_KEY

⏱ Cron Jobs

crontab* * * * * curl -s https://yourdomain.com/api/cron >
                    /dev/null 2>&1

✨ Feature Overview

🏗 Architecture

Built on CodeIgniter 4 MVC. All routing defined in app/Config/Routes.php.

Request Lifecycle

Browser → Routes.php → Filter (auth/sameorigin) → Controller → AppModel → JSON/View

Controller Hierarchy

CodeIgniter\Controller
                    └── BaseController ← helpers, settings, email, push, QR, caching
                    ├── AuthController
                    ├── FrontController
                    ├── DepositController
                    ├── WithdrawalController
                    ├── TradeController
                    ├── InvestmentController
                    ├── KycController
                    ├── UserController
                    └── ... (31 controllers total)

AppModel is a single generic model wrapping CodeIgniter's Query Builder. All results are cached by table name and invalidated on each write.

📁 Directory Structure

cryptomax/
                    ├── app/
                    │ ├── Config/ # Framework and app configuration
                    │ ├── Controllers/ # 31 controllers
                    │ ├── Database/
                    │ │ ├── Migrations/ # 19 migration files
                    │ │ └── Seeds/ # 4 seeders
                    │ ├── Filters/ # auth:guest|user|admin, sameorigin
                    │ ├── Libraries/ # DeviceInfo, GeoIP, LoginSecurity, Translator
                    │ ├── Models/
                    │ │ └── AppModel.php # Generic CRUD model
                    │ └── Views/
                    ├── public/ # ← Point your web server here
                    │ ├── assets/
                    │ └── uploads/
                    ├── writable/ # Logs, cache, sessions (must be writable)
                    ├── vendor/ # Included — no Composer needed
                    └── .env # Never commit this file

⚡ API Reference

All endpoints return JSON. Authenticated endpoints require an active session cookie.

Response Envelope

json{ "success": true, "type": "redirect|confirm|alert", "title":
                    "...", "text": "...", "url": "..." }

Public Endpoints

User Endpoints (authenticated)

Admin Endpoints (authenticated)

⚡ Cache Management

Caches are named after their source tables and invalidated automatically on every write. Settings are cached for 24 hours.

GET /cache/clear # via browser
                    php spark cache:clear # via CLI

🔒 Security

💻 CLI Reference

bashphp spark serve # Local dev server
                    php spark migrate # Run pending migrations
                    php spark migrate:rollback # Roll back last batch
                    php spark db:seed SeederName # Run a specific seeder
                    php spark key:generate # Generate encryption key
                    php spark cache:clear # Clear all caches
                    php spark make:migration Foo # Scaffold a new migration