Getting Started

This guide will walk you through the steps to set up and compile HarmonyLinkServer on your system.

Prerequisites

Before getting started, make sure you have the following prerequisites:

• A working installation of Rust.
• Familiarity with Rust syntax and concepts.
• Git installed on your system.

Clone the Repository

To begin, you need to clone the HarmonyLinkServer repository using Git. Open your terminal or command prompt and enter the following command:

git clone https://github.com/Jordonbc/HarmonyLinkServer.git

This will create a local copy of the repository on your machine.

Navigate to the Project Directory

Once the repository is cloned, navigate to the project directory using the cd command:

cd HarmonyLinkServer

You should now be inside the HarmonyLinkServer project directory.

Build the Project

To build the HarmonyLinkServer project, use the following command:

cargo build

This command will compile the project and download any necessary dependencies. If successful, you will see the build output in your terminal.

Run the Project

To run the HarmonyLinkServer, execute the following command:

cargo run

This will start the server application, and you will see relevant logs and information in your terminal.

Congratulations! You have successfully set up and compiled HarmonyLinkServer on your system. You can now proceed to interact with the API using the available endpoints.

For more information on the API endpoints and their usage, refer to the Endpoints documentation.

Troubleshooting

If you encounter any issues during the setup or compilation process, refer to the project's issue tracker on GitHub for known issues and possible solutions. You can also seek help from the project's community or open a new issue if needed.

We hope this guide helps you get started with HarmonyLinkServer. Happy coding!