Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 1.73 KB

BUILDING.md

File metadata and controls

73 lines (45 loc) · 1.73 KB

Building

Pre-requisites

Some build tools require Python.

Setup

Install the Rust toolchain

Install the appropriate Rust toolchain for your native OS/platform by following these instructions.

We are using the stable toolchain only.

Install just

Many development tasks have been automated with recipes for just that can be found in .justfile.

Install just through cargo:

cargo install just

Install build tooling

The remaining setup of all build tooling is accomplished by running the following command:

just setup

Build and run the web service

Use the following command to build the web service as a standalone executable

cargo run --profile dev --package aoide-websrv

Build profiles

The following build profiles are available.

dev

  • Default
  • Slow at runtime, only for development and debugging
  • Executable: target/debug/aoide-websrv

release

  • Reasonably optimized and fast, both building and running
  • Executable: target/release/aoide-websrv

production

  • Optimized for maximum speed at runtime
  • Slow to build
  • Executable: target/production/aoide-websrv

Run configuration

The last settings are stored in a local configuration file and could be overridden by both environment variables and a dotenv (.env) file. Watch the log messages for details.

When started without any environment variables set the Launcher UI will appear. Set LAUNCH_HEADLESS=true to suppress the Launcher UI.