scsys-xtask 0.0.0

A custom build system for the scsys ecosystem
Documentation

scsys-xtask

[crate.io (license)

crates.io docs.rs

Docker Image Version

Warning: The application is currently in the early stages of development and is not yet ready for production use.

scsys-xtask is a custom build system for the scsys-io ecosystem, designed to support a variety of workflows that empower our all-in-one platform, eryon.

Features

  • Docker support
  • Native support
    • Linux support (x86_64-unknown-linux-gnu)
    • MacOS support (x86_64-apple-darwin)
    • Windows support (x86_64-pc-windows-msvc)
    • FreeBSD support (x86_64-unknown-freebsd)
    • OpenBSD support (x86_64-unknown-openbsd)
    • DragonFly BSD support (x86_64-unknown-dragonfly)
    • NetBSD support (x86_64-unknown-netbsd)
  • NixOs support
  • WebAssembly support
    • Emscripten support (wasm32-unknown-unknown)
    • WebAssembly System Interface (WASI) support (wasm32-wasip1, wasm32-wasip2)

Usage

Library: scsys-xtask

Add the following to your Cargo.toml:

[dependencies.scsys-xtask]
version = "0.0.*"
features = ["full"]

Binary: scsysx

Installation

cargo binstall scsys-xtask

Running the server

pzzld serve --port 8080

Getting Started

Setting up

Ensure that rustup and all installed toolchains are updated:

rustup update

Optionally, instal the wasm32-* targets for WebAssembly development:

rustup target add wasm32-unknown-unknown wasm32-wasip1 wasm32-wasip2

Building from the source

Get started by cloning the repository:

git clone https://github.com/FL03/scsys-xtask.git --branch main

Then, navigate to the project directory:

cd scsys-xtask

Native

For native development, you can run the server using cargo:

cargo run --locked --release --features full --bin pzzld --

WebAssembly

WebAssembly System Interface (wasi)

Build the project using the wasm32 target:

cargo build --locked --workspace --release --features wasi --target wasm32-wasip2

Docker

You can also build the project using Docker. Start by building the Docker image:

docker buildx build --platform linux/amd64 -t jo3mccain/scsys-xtask:latest -f ./Dockerfile .

Then, run the Docker container:

docker run -d -it --rm -p 8080:8080 -v $(pwd):/app jo3mccain/scsys-xtask:latest

This will start the server and bind it to port 8080 on your host machine. You can access the server by navigating to http://localhost:8080 in your web browser.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.