This workspace contains the core API and internal utility crates essential for the development and operation of our AerodisSpace streaming platform dedicated to model aviation. Here, you'll find everything needed to set up, run, and contribute to the server that powers our real-time streaming experience.
- API: The application programming interface that manages communication between the platform's clients and the database, as well as integrating real-time sensor data.
- Utility Crates (Utils): A set of internal libraries developed to support API operations, including data manipulation, hardware communication, and performance optimizations.
To work on this workspace, you'll need to install some essential tools and libraries:
We use charybdis-migrate for managing database migrations. Install it with the following command:
cargo install charybdis-migrate- Automatic Migrations: The build command is configured to perform migrations automatically with each compilation. This helps keep the database schema in sync with the current version of the code.
For complete details on the API and LIVE, and how to use the utility crates, please consult our documentation. The documentation is available at the following link: AerodisSpace Server Documentation.
We are always looking for improvements and value the community's contribution. If you are interested in contributing to the AerodisSpace Server Workspace, see below for how to get started:
-
Clone the Repository: Fork and clone the repository to start working locally on your improvements.
-
Install Dependencies: Make sure you have all necessary dependencies installed.
-
Make Your Changes: Implement your improvements or fixes.
-
Test Locally: Use the available tests to ensure your contribution does not break any existing functionality.
-
Open a Pull Request: Submit your changes for review. For more information on how to contribute, please see our contribution guide in the repository.