storipress/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_?](https://developers.storipress.com/karbon/2gLtVFS6QEkdvKF7fkRng1/overview/4P2M8yS9k5s8F7FXgTSyKr#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](https://github.com/storipress/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](https://plausible.io/blog/google-amp)_
- 🔦 Instant-search, baked in
- And [a bunch more][documentation]

Spin up a Karbon app in your browser with our [playground](https://karbon.new/) or set up your local environment with the instructions below ⬇️

## Available Templates

Visit the [Karbon Starter Template repo](https://github.com/storipress/karbon-starter) to see all available templates.

## Usage

```bash
# 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:**

```bash
# Using `yarn`
yarn create @storipress/karbon

# Using `npm`
npm init @storipress/karbon

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

**Running locally:**

1. Start a development server

```bash
# Using `yarn`
yarn install
yarn dev

# Using `npm`
npm i
npm run dev
```

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

Learn more about [getting started with Karbon](https://developers.storipress.com).

## Contributing to Karbon

[Read our contributing guide](/CONTRIBUTING.md)

## Other handy links

[Learn more about Karbon][documentation].

👷‍♀️ Add `npm` packages to your project:

[documentation]: https://developers.storipress.com