@storipress/create-karbon

@storipress/create-karbon

Create a new Karbon app in seconds.

What is Karbon?

Built on Nuxt 3, Karbon is a Vue-based framework for building dynamic, custom publications. Why Vue?

Why did we make Karbon? 👇

• 💨 A really, really productive headless developer experience
• ⚡️ Lightning fast load speeds
• 🔎 Enterprise SEO utilities
• 👨‍👩‍👦‍👦 Large ecosystem: compatable with all Nuxt plugins
• 🌮 Recommended articles out of the box, with extensible custom logic
• ∞ SEO friendly infinite scroll
• 💳 Paywall, checkout and card management
• 💸 Simply programmatic ad-ops with native integration to vue-advertising
• 😱 Instantly generate collection pages (i.e. category pages, brand pages)
• 😤 No AMP — ok, you can use AMP if you really want, but you really don't need to
• 🔦 Instant-search, baked in
• And a bunch more

Spin up a Karbon app in your browser with our playground or set up your local environment with the instructions below ⬇️

Available Templates

Visit the Karbon Starter Template repo to see all available templates.

Usage

# Use the default template under `karbon-app`
yarn create @storipress/karbon
# Use the default template
yarn create @storipress/karbon <project-name>
# Full usage
yarn create @storipress/karbon <template-name> <project-name>

Getting Started

Requirements:

• yarn or pnpm
• Node.js version 16.14.0 or higher

Installation:

# Using `yarn`
yarn create @storipress/karbon

# Using `npm`
npm init @storipress/karbon

# Using `npx`
npx @storipress/create-karbon

Running locally:

• Start a development server

# Using `yarn`
yarn install
yarn dev

# Using `npm`
npm i
npm run dev

• Visit the development environment running at http://localhost:3000.

Learn more about getting started with Karbon.

Contributing to Karbon

Read our contributing guide

Other handy links

Learn more about Karbon.

👷‍♀️ Add npm packages to your project: