Runway
HomeComponentsPricingDev Tools

Start Here

  • Overview
  • Installation
  • Project Structure

Customize

  • Customization
  • Runtime Configuration
  • Site Content

Build

  • Components
  • Layout
  • Brand

Product Systems

  • Auth, Billing, Email, SEO, Security
Loading docs page
Built withRunway
  1. Start Here
  2. Installation

Installation

Clone the repo, configure local env, and boot the site locally.

Quick start

Use the standard Next.js workflow defined in package.json.

bash
1git clone https://github.com/Runway-js/runway.js.git your-project-name
2cd your-project-name
3npm install
4npm run dev

Open http://localhost:3000 after the dev server starts.

Local environment

Create .env.local from the example file and only turn on the providers you actually need for the work in front of you.

If you are working on the public site or docs first, you can usually leave auth, billing, and email providers disabled until you are ready to wire those flows.

Stay narrow

The fastest path is usually: boot the repo, replace the public copy and brand, then enable product systems in the order you need them.

Verification

Use these as the baseline checks before you move on:

bash
1npm run lint
2npm run build

If you changed docs content, also confirm the page appears in the sidebar and search and resolves from its URL.

Related

  • Overview
  • Project Structure
  • Customization

On This Page

  • Quick start
  • Local environment
  • Verification

Related

  • Overview
  • Project Structure
  • Customization