Skip to content
forked from candlecorp/wick

Wick is a lightweight framework for building secure and scalable software services.

License

Notifications You must be signed in to change notification settings

fawadasaurus/wick

 
 

Repository files navigation

wick logo

Wick

Wick is a free and open platform for building applications out of WebAssembly code containers.

Wick lets you write code and reuse it easily, everywhere. It's built with Rust and Wasmtime and takes ideas from Docker, Kubernetes, Erlang, Rx, FBP, and more.

Getting Started

Visit the docs in the Wick Wiki for the getting started guide and API documentation.

Quick Install - Mac and Linux

Mac and Linux users can install the latest stable version of Wick with the following command:

curl -sSL sh.wick.run | bash

To download and install the nightly version, or other releases of wick, pass a single argument of the desired release.

curl -sSL sh.wick.run | bash -s -- nightly

Quick Install - Windows

Windows users can install the latest stable version of Wick with the following command:

curl https://ps.wick.run -UseBasicParsing | Invoke-Expression

To download and install the nightly version, or other releases of wick, pass a single argument of the desired release.

curl https://ps.wick.run -OutFile setup-wick.ps1; .\setup-wick.ps1 -ReleaseVersion "nightly"; rm setup-wick.ps1;

Manual Install

If you want to set it up manually, you can go to the releases page to download precompiled binaries for your platform.

Make sure you add the binary location to your path.

Compile from Source

Clone the repository and run the install task with just, you will need to ensure the path is updated appropriately for your system:

$ just install

or for more optimized builds:

$ just install-release

Prerequisites for building from source

Aside from rust & cargo, you'll need node.js & npm to run and build the code generator.

You can install all the prerequisites for tools that can be installed via rust and npm with the command:

$ just deps

jq

The tasks also make use of jq. Find installation instructions on the jq homepage: https://stedolan.github.io/jq/

cmake

The generated protobuf code uses prost which depends on a number of developer tools. Many developer systems will probably have these installed already, but recent macs no longer include cmake with the XCode CLI tools. You'll need either the full xcode installation or homebrew to install it.

You can install xcode from the app store or you can install cmake via brew with the command:

$ brew install cmake

Rust nightly

You'll also need the rust nightly toolchain in addition to stable for some of the dependent tools and code formatting.

$ rustup toolchain add nightly

Building Wick

Build Wick with just alone.

just build

Running tests

Run unit and self-contained integration tests via just

just test

To run the full suite of tests, you'll need a local NATS server, redis instance, and OCI registry. You can run these with the docker-compose.yml file in the /etc/ directory.

$ cd scripts && docker-compose up

About

Wick is a lightweight framework for building secure and scalable software services.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Rust 89.3%
  • HTML 4.5%
  • Handlebars 3.0%
  • JavaScript 0.9%
  • Svelte 0.8%
  • Shell 0.6%
  • Other 0.9%