Get Started

Quick Start

The fastest way to get started with Polen is using the create command:

npx polen create my-graphql-docs
cd my-graphql-docs
npx polen dev

This will:

1. Create a new Polen project with a working example
2. Install all dependencies
3. Start the development server

Your developer portal is now running at http://localhost:3000!

Manual Setup

1. Install Polen

   npm init
   npm add polen

2. Create a schema.graphql file with your GraphQL schema:

   type Query {
     hello: String
   }

3. Add scripts to your package.json:

   {
     "scripts": {
       "dev": "polen dev",
       "build": "polen build"
     }
   }

Adding Examples

Create an examples directory and add .graphql files:

# examples/hello.graphql
query HelloWorld {
  hello
}

Examples appear automatically on your home page. Learn more: Examples

Next Steps

• Edit schema.graphql to use your own GraphQL schema (Schema Reference)
• Add your content as markdown in the arbitrary-pages directory (Arbitrary Pages)
• Build and deploy your portal (Deployment (SSG), Deployment (SSR))