Skip to content

synadia-io/nex

Repository files navigation

Lint | Test | Build Release Homepage and Documentation eg GitHub License GitHub go.mod Go version Go Report Card Go Reference

NATS Execution Engine

Leverage and extend your investment in NATS infrastructure to deploy functions and services, turning NATS into the ultimate platform for building distributed applications.

Prerequisites

Taskfile

Nex uses Task for building, testing, and releasing. You can install Task by following the instructions here

Protobuf | Go-jsonschema

Nex relies on Protobuf and Go-jsonschema for defining the API and messages. While many linux distros have Protobuf available in their package repositories, it is recommended to install the version matching what is defined in CI from the official releases. You can find the latest release here

The included Taskfile has a task defined for downloading and installing the required dependencies.

task install-deps

Getting Started

Currently, there are no pre-built binaries available. To build from source, make sure the prerequisites are installed. Once you got these dependencies installed and this repository cloned, you can build the nex binary with the following command:

task nex

With the nex binary built and a local nats server running, we can finally run our node:

mkdir -p ~/.config/nex
target/nex node up