Perquisites

Before installing and deploying Ridy, ensure the following prerequisites are met to avoid errors during setup and to ensure a fully functional, secure environment.

📦 Code Access

• The full source code is provided as a downloadable ZIP archive.
• No need to install Git or manage repositories.

💻 Server Requirements

• A VPS or cloud instance running Ubuntu 22.04 LTS.
• Static IP address (mandatory for license validation and SSL setup).
• Root or sudo access to run installation scripts.

⚙️ Installation Script

• A one-line automated install script is provided.
• This script:
  • Installs Docker and Docker Compose (if not already installed)
  • Pulls and builds required containers
  • Starts all backend and admin services

No need for manual dependency installation — everything runs in Docker containers.

🌐 Domain & HTTPS

• A valid domain name or static IP is required.
• HTTPS/SSL is not set up automatically. Manual configuration is needed.
  • Cloudflare reverse proxy setup is highly recommended for ease of SSL and caching.
  • Alternatively, self-hosted SSL (e.g., via Let’s Encrypt) can be configured post-deployment.

📱 Mobile App Requirements

• Apps are provided in source code format and must be compiled locally.
• Requirements:
  • Android SDK 21+
  • Flutter (stable channel)
  • Xcode (for iOS builds)
• Firebase Setup Required for:
  • Push notifications
  • App configuration

Firebase keys must be set up in each app before compilation.

🔑 API Keys & Configs

• A preconfigured .env.example file is included to help with environment setup.
• Required configurations:
  • Map Provider Keys (for Google Maps, Mapbox, MapLibre, etc.) — configured via .env
  • SMS & Payment Gateway Keys — entered directly from the Admin Panel under their respective configuration pages