# Run a first ryu example

Start with the smallest workflow described by the README for **ryu**. Complete [installation and configuration](/docs/up-to-code-ryu/installation-guide) first.

## Quick start

### Install a self-hosted node

**macOS and Linux**:

```bash
curl -fsSL https://raw.githubusercontent.com/amajorai/ryu/main/install.sh | sh
ryu-cli
```

**Windows PowerShell**:

```powershell
irm https://raw.githubusercontent.com/amajorai/ryu/main/install.ps1 | iex
ryu-cli
```

The installer starts Core and the Gateway with the bundled local defaults. Read the
[self-hosting guide](https://ryuhq.com/help/docs/start-here/getting-started/self-host)
for providers, deployment, and configuration.

## Verify your changes

The root manifest provides this check:

```sh
npm run test
```

Read any errors before continuing. Build and type checks verify source consistency; exercise the README example to verify the behavior you need.

## Next task

[Read the usage guide](/docs/up-to-code-ryu/usage-guide) for the documented components, configuration, and source layout.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/ryu)
- [Original README](https://github.com/Up-to-code/ryu/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/ryu/issues)
- [Open the project website](https://ryuhq.com)


This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.