airlinklabs / panel

Airlink is a simple to use Game server managment panel
MIT License
14 stars 11 forks source link

(suggestion) Updated README.md File: #3

Closed choice21hax closed 1 month ago

choice21hax commented 1 month ago

AirLink

AirLink is an open-source project developed by AirLinkLabs. It is a web-based platform designed to manage nodes and servers efficiently. This project is licensed under the MIT License.

Table of Contents

Features

Installation

  1. Clone the repository:

    git clone https://github.com/airlinklabs/airlink.git
    cd airlink
  2. Install dependencies:

    npm install
  3. Set up the environment variables:

    Create a .env file in the root directory and configure it as follows:

    url="http://localhost:3000"
    PORT=3000
    NAME="Airlink"
    SECRET="your_secret_key"
    DATABASE_URL="file:./dev.db"
  4. Run the application:

    npm start

Usage

Contributing

Contributions are welcome! Please follow these steps:

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

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, please contact us at support@airlinklabs.com.

Join our Discord Server for community support and discussions.

Visit our GitHub Repository for more information.

Support the project on Ko-fi.

privt00 commented 1 month ago

We make our own Readme in the future, but thanks anyways for trying to contribute to Airlink.

Stupedo commented 1 month ago

Oh :D