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.

🛠 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-deploy

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

📄 License

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

Made with ❤️ by AirLink Labs