Getting Started

Introduction

Thank you for purchasing Servix SaaS Platform.

This documentation will guide you through the installation, configuration, and management of your platform.

Servix is a complete personnel and job management SaaS solution designed for service-based businesses. It allows you to manage employees, jobs, customers, and payments from a single dashboard.

✔ Easy to Start

No advanced technical knowledge is required to complete the installation.

Who Is This Platform For?

Servix is ideal for:

Technical service companies
Field service businesses
Small to medium-sized teams
Companies managing personnel and job assignments

If your business handles daily jobs, staff coordination, and customer management, Servix is built for you.

What’s Included

Web Admin Panel
Staff & Personnel Management
Job & Service Tracking
Flutter Mobile Application (Source Code Included)
Automated Installation Wizard
PostgreSQL Database Support

Requirements

Minimum Requirements

Node.js 18+
PostgreSQL 14+
2GB RAM
Linux-based OS (Ubuntu 20.04+ recommended)

Recommended for Production

4GB RAM
Ubuntu 22.04 LTS

Installation Guide (3 Easy Steps)

We designed an automated installer that handles most of the setup process.

Automated Setup

The installation wizard will automatically configure the system for you. You do not need to edit environment files manually.

Step 1: Install Dependencies

Open your terminal in the project root directory and run:

TERMINALnpm run setup:start

This command installs all required packages for Backend, Web, and Mobile tools.

Step 2: Start the System

Start the orchestrator with a single command:

TERMINALnpm start

Step 3: Installation Wizard

Open your browser and navigate to http://localhost:3000.
You will see the Servix Installation Wizard.
Follow the on-screen instructions to connect your Database and create your Admin account.

Demo Access

Preview Credentials

You can use these credentials to test the system immediately after installation.

Note: Demo data is reset periodically.

Admin Panel

Email: admin@demo.com
Password: admin123

Staff Panel (Mobile)

Email: staff@demo.com
Password: staff123

Mobile Application

Servix includes a full-featured mobile application built with Flutter.

Staff members can manage jobs, update statuses, and view assignments directly from their mobile devices. Both Android and iOS platforms are supported.

Building APK

You can generate a production-ready APK file directly from the root directory without complex Flutter commands.

TERMINALnpm run build:mobile

The APK file will be generated at: apps/mobile/build/app/outputs/flutter-apk/app-release.apk

Building for iOS

If you are on macOS, you can build for iOS (unsigned):

TERMINALnpm run build:mobile:ios

Configuration

Most settings are handled automatically, but here are the manual overrides if needed.

Environment Variables

The system uses .env files located in apps/backend and apps/web. These are strictly for advanced users.

Mobile Backend URL

Production Tip

For production deployments, you may optionally adjust the backend URL in the mobile configuration file if required:

apps/mobile/lib/core/constants/app_config.dart

License Information

Regular License

Single company use
Internal business usage only (e.g., using it for your own service company)

Extended License

SaaS usage (Reselling the service to other companies)
Multiple client installations

Please ensure you purchase the correct license type according to your use case.

Support & Updates

Support: Provided via CodeCanyon comments or email support.
Updates: Free lifetime updates are delivered according to CodeCanyon policies.

FAQ

How do I reset my admin password?

You can use the "Forgot Password" link on the login page or manually reset it via database access.

Can I host this on Shared Hosting?

We recommend a VPS (Virtual Private Server) like DigitalOcean, AWS, or Hetzner. Standard shared hosting (cPanel) may not support Node.js processes correctly.