Skip to content

zooai/node

Repository files navigation


Zoo Node

Zoo Node by Zoo Industries Inc. allows you to create AI agents without touching code. Define tasks, schedule actions, and let Zoo write custom code for you. Native crypto support included.

There is a companion repo called Zoo Apps which contains the frontend that encapsulates this project, you can find it here.


Documentation

General Documentation: https://docs.zoo.ai

Installation (Local Compilation)

Prerequisites

  • Rust version >= 1.85 (required for std::fs::exists functionality)

Please refer to the installation instructions for your operating system:

Build

Easy Build

sh scripts/run_node_localhost.sh

if you want to restart the node, you can delete the folder storage and run the build again. More information at https://docs.zoo.ai/getting-started.

Build Zoo Rust Node

cargo build

Note: You must run this command from the root directory of this repo and make sure that you have set the required ENV variables.

OpenAPI

Generate schemas

Run the following command to generate the schema files:

cargo run --example generate_openapi_docs

The result will be placed in the folder docs/openapi.

Swagger UI

http://{NODE_IP}:{NODE_API_PORT}/v2/swagger-ui/

The Swagger UI assets are not built by default to avoid network downloads during tests. If you want to include them, compile with the swagger-ui feature:

cargo build --features zoo_node/swagger-ui

Tests

Note: You must run these tests from the root directory of this repo.

Test Zoo Rust Node Only

Simply use the following to run all rust node tests:

IS_TESTING=1 cargo test -- --test-threads=1

For running a specific test (useful for debugging) you can use:

IS_TESTING=1 cargo test tcp_node_test -- --nocapture --test-threads=1

Running Dockerized Tests

Main tests

# Build testing image
docker build -t testing_image -f .github/Dockerfile .

# Run tests main cargo tests
docker run --entrypoint /entrypoints/run-main-cargo-tests.sh testing_image

Further CI Development

Use act -j test-wasm -P self-hosted=nektos/act-environments-ubuntu:18.04 --container-architecture linux/amd64 to run the tests locally in a docker container. This is useful for debugging CI issues.

Releasing a New Version

When releasing a new version, ensure that you update the Cargo.toml of the zoo-node as well as the Cargo.toml of the zoo-libs/zoo-http-api library.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages