Getting Started

From Template to Running App

Five steps to go from "Use this template" to a fully running application on your machine. Works on Windows, macOS, and Linux out of the box.

Prerequisites

Make sure you have these tools installed before you begin. Don't worry - the init script will catch any missing dependencies for you.

Git

Version control - required

Docker

Container runtime for the full stack - required

.NET SDK

Required - builds and runs the backend

Node.js + pnpm

Required - runs the frontend toolchain

Setup in 5 Steps

Follow along from start to finish - you'll be up and running in minutes.

Visit the Repository

Head to the NETrock GitHub repository and click the "Use this template" button.

Open NETrock on GitHub

Look for the "Use this template" button near the top of the page.

Create from Template

GitHub will ask you to name your new repository and choose its visibility. Pick a name, set it to public or private, and click "Create repository".

Your new repo starts clean - same foundation as this demo, without the sample data.

Clone & Initialize

Clone your new repository and run the initialization script to set up your project.

bash

git clone https://github.com/your-username/your-repo.git

cd your-repo && ./init.sh

The init script renames the solution, updates namespaces, and sets up Aspire orchestration.

Start the Stack

Launch the full development stack with a single Aspire command.

dotnet run --project src/backend/YourProject.AppHost

Aspire starts PostgreSQL, MinIO, the API, and SvelteKit frontend with an integrated OpenTelemetry dashboard.

Start Coding

Your app is running. Open your IDE or Claude Code and start building.

Via Aspire

Frontend

localhost:13000

Backend API

localhost:13002

Without Aspire

Or run the frontend and API directly outside Aspire - they connect to the database and storage services automatically.

Frontend

localhost:5173

Backend API

localhost:5142

Ports are configurable via environment variables. See the README for details.

What's Next

Once you're up and running, here are some recommended next steps.

Connect an email provider (SMTP, Resend, Postmark…) Build your first feature following SKILLS.md Set up CORS, JWT secret & CAPTCHA for production Figure out your deployment strategy Review the Before You Ship checklist

Resources

Useful links to help you along the way.

GitHub Repository

Source code, issues, and contributions.

Documentation

Full README with setup guides and conventions.

DeepWiki

AI-generated documentation and code exploration.

Explore the Demo

Jump back to the guide and try every feature hands-on.

Five Steps. That's It.

You've seen the steps - now use the GitHub template and have a running app in minutes.

Use This Template Back to the Guide