Table of Contents

• AltV Server Manager
• Features to be Implemented
• Completed Features
• Getting Started
  • Installation
  • Configuration
  • Starting
• License
• Contribution

AltV Server Manager

AltV Server Manager is a web application designed to simplify the management of AltV servers. It provides a user-friendly interface for server administrators, allowing them to monitor and control their servers with ease.

Features to be Implemented

• Start server button
• Stop server button
• Restart server button
• Live console
• Server configuration editor
• Player list
• Player management (e.g., banning)

Completed Features

• Discord Login
• Server creation
• Downloading the latest altv server based on the operating system (Windows/Linux) under server-data
• Accessing the server page in the backend
• Automatic port assignment during server creation
• Synchronize the port in the configuration file with the database port whenever a change is detected
• Server status indicators in the navigation sidebar:
  • Green: The server is installed.
  • Yellow: The server is currently being installed.
  • Red: The server is neither installed nor being installed, and needs to be installed by pressing the install button.

Getting Started 🚀

Before you begin, ensure that you have met the following requirements:

• You have installed the latest version of Node.js and npm.
• You have installed Git on your machine.

Installation 🛠️

1. Clone this repository:

   git clone https://github.com/caglarop/altv-server-manager.git

2. Navigate to the directory:

   cd altv-server-manager

3. Install the dependencies:

   npm install

   or if you prefer using Yarn:

   yarn install

Configuration ⚙️

1. Copy the .env.example file and rename it to .env. Fill it with the necessary environment variables as per the provided settings.
2. Run the following commands to migrate the database:

   npx prisma generate
   npx prisma migrate dev

   or if you prefer using Yarn:

   yarn prisma generate
   yarn prisma migrate dev

Starting 🎬

To start the panel, run the following command:

npm run dev

or if you prefer using Yarn:

yarn dev

After starting the development server, open your web browser and navigate to http://localhost:3000. From there, you can add your AltV servers and start managing them.

License 📜

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

Contribution 🤝

Contributions are welcome! If you have a feature request, bug report, or proposal for code improvement, please feel free to open an issue or submit a pull request.