The Server Tracker is a web application that allows users to track Minecraft & Hytale servers.
To build the Server Tracker, follow these steps:
Highly recommended to install Bun for the package management.
Clone the repository:
$ git clone https://github.com/Rishon/Server-Tracker
Install the dependencies:
$ cd Server-Tracker/client $ bun installAdjust the environment variables:
NEXT_PUBLIC_API_URL=<API URL>NEXT_PUBLIC_HOSTNAME=<Hostname>
Start the development Next.JS server:
$ bun dev
Install the dependencies:
$ cd Server-Tracker/server $ bun installAssign the environment variables:
$ cp .env.example .env
Adjust the environment variables:
BACKEND_PORT=<Port>MONGODB_URL=<MongoDB URI>
Start the development server:
$ bun dev
To deploy the Server Tracker, follow these steps:
Build the Next.JS application:
$ cd Server-Tracker/client $ bun run buildRun the docker-compose file:
$ cd Server-Tracker $ docker-compose up -d
If you discover a bug, please open up an issue.
To contribute to the Server Tracker, follow these steps:
- Fork this repository.
- Create a new branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m "<commit_message>". - Push to the branch:
git push <remote> <branch>. - Create the pull request.