Caution

AirLink is in development for a while and is getting used by a few people, please wait an release version

Airlink Panel 🚀

Streamlined Game Server Management

📖 Overview

Airlink Panel is an advanced, open-source game server management platform designed to simplify server deployment, monitoring, and administration. With its powerful addon system, you can extend the functionality of the panel to suit your specific needs.

🛠 Prerequisites

• Node.js (v16+)
• npm (v8+)
• Git
• Supported Database (PostgreSQL/MySQL)

💾 Installation

1. Clone the repository:

   cd /var/www/
   git clone https://github.com/AirlinkLabs/panel.git
   cd panel

2. Set 755 permissions on the panel directory:

   sudo chown -R www-data:www-data /var/www/panel
   sudo chmod -R 755 /var/www/panel

3. Install dependencies:

    npm install -g typescript
    npm install --production

4. Configure the Prisma database and run migrations:

   npm run migrate:dev

5. Build the application:

   npm run build-ts

6. Run the application:

   npm run start

Running with pm2 (Optional)

1. Install pm2:

   npm install pm2 -g

2. Start the application using pm2:

   pm2 start dist/app.js --name "panel"

3. Set up pm2 to auto-start on server reboot:

   pm2 save
   pm2 startup

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contribution Guidelines

• Follow TypeScript best practices
• Write unit tests for new features
• Maintain clean, readable code
• Update documentation

🧩 Addon System

AirLink Panel features a powerful addon system that allows you to extend its functionality. Addons can add new features, modify existing ones, and integrate with external services.

Creating Addons

To create an addon, follow these steps:

1. Create a new directory in the panel/storage/addons/ folder with your addon's slug
2. Create a package.json file with your addon's metadata
3. Create an entry point file (default: index.ts)
4. Implement your addon's functionality

For more information, check out these resources:

• Quick Start Guide
• Complete Addon Documentation
• Database Migrations Guide

📄 License

Distributed under the MIT License. See LICENSE for more information.

Made with ❤️ by AirLink Labs