Installation
Install the NestForge CLI, create an application, and run it locally.
What this page is for
Section titled “What this page is for”This page is for application developers using NestForge to create and run a service.
If you want to work on the NestForge framework repository itself, use the framework developer setup in the contributing docs instead.
Prerequisites
Section titled “Prerequisites”To create and run a NestForge app you need:
- a stable Rust toolchain
cargogit
Install the CLI
Section titled “Install the CLI”Install the CLI from Cargo:
cargo install nestforge-cliIf you are developing against a local checkout of the framework, you can install the CLI from the repository workspace instead:
cargo install --path crates/nestforge-cliCreate a project
Section titled “Create a project”After the CLI is installed, scaffold a new project:
nestforge new demo-apicd demo-apicargo runRun the app
Section titled “Run the app”The generated app starts with the normal Rust workflow:
cargo runTypical local default for an HTTP service:
http://127.0.0.1:3000
Add the features you need
Section titled “Add the features you need”NestForge is modular at the Cargo level. Enable only the feature sets your application needs. Common examples:
nestforge = { version = "1", features = ["config", "openapi"] }nestforge = { version = "1", features = ["graphql"] }nestforge = { version = "1", features = ["grpc", "microservices"] }Depending on your stack, you may also need:
protocfor gRPC code generation- a reachable database for database-backed application code
Next step
Section titled “Next step”Continue with CLI Workflow or go straight to Quick Start.