Overview

This section contains practical guides for different user roles and tasks.

---

Guide Categories

Development

For developers building or contributing to NCN:

• Environment Setup - Prerequisites and tools

• Building - Build from source

• Running Locally - Local development

• Testing - Run tests

• Debugging - Debug tips

Deployment

For deploying NCN to different environments:

• Docker - Container deployment

• Manual - Manual installation

• Kubernetes - K8s deployment

• Production - Production considerations

Operators

For running NCN infrastructure:

• Gateway Operator - Run a gateway

• Compute Operator - Provide compute

• Validator Operator - Run a validator

• Monitoring - Set up monitoring

Clients

For integrating with NCN:

• gRPC Client - gRPC integration

• HTTP Client - REST API integration

• Payment Integration - Payment flow

• Examples - Code examples

---

Quick Links by Task

I want to...

Task	Guide
Try NCN locally	Getting Started
Set up development	Environment Setup
Build from source	Building
Deploy with Docker	Docker Deployment
Run a Gateway	Gateway Operator
Provide compute	Compute Operator
Integrate my app	Client Guides
Debug an issue	Debugging

---

Guide Conventions

Prerequisites

Each guide lists prerequisites at the top:

Prerequisites:
- Rust 1.70+
- Python 3.8+
- Docker 20.10+

Code Examples

Code blocks show commands to run:

# This is a command to run
cargo build --release

Placeholders

Placeholders are indicated with <brackets> or YOUR_VALUE:

export PRIVATE_KEY=<your-private-key>
export PRIVATE_KEY=YOUR_PRIVATE_KEY

Notes and Warnings

Note: Important information

Warning: Critical information that could cause issues

---

Feedback

If you find issues with these guides:

• Open a GitHub issue

• Submit a pull request

• Provide feedback via community channels