storipress/karbon

![Karbon](https://user-images.githubusercontent.com/53453555/225268246-0f8e1ca6-0f24-4d77-8fa6-c298c00c741e.png)

<p align="center">
    <a href="https://codeclimate.com/github/storipress/karbon/maintainability"><img src="https://api.codeclimate.com/v1/badges/d3374e57dd63a3565c18/maintainability" /></a>
    <a href="https://codeclimate.com/github/storipress/karbon/test_coverage"><img src="https://api.codeclimate.com/v1/badges/d3374e57dd63a3565c18/test_coverage" /></a>
    <a href="https://www.npmjs.com/package/@storipress/karbon"><img src="https://img.shields.io/npm/v/@storipress/karbon?sanitize=true" alt="Version"></a>
    <a href="https://github.com/storipress/karbon/blob/main/LICENSE.md"><img src="https://img.shields.io/npm/l/@storipress/karbon.svg?sanitize=true" alt="License"></a>
    <a href="https://npmcharts.com/compare/@storipress/karbon?minimal=true"><img src="https://img.shields.io/npm/dm/@storipress/karbon?sanitize=true" alt="Downloads"></a>
 </p>

<div align="center">

📚 [Docs][documentation] | 🗣 [Slack](https://join.slack.com/t/storipresscommunity/shared_invite/zt-1krx5nm1d-h_WKy1XF3MSxuY4BQ0VRbQ) | 💬 [Discussions](https://github.com/storipress/karbon/discussions) | 📝 [Changelog][changelog]

</div>

# _Carbon_ /ˈkɑːbən/: the first pigment humans used for ink

**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]

Set up a Karbon app in your local environment with the instructions below ⬇️

## 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][documentation].

## Contributing to Karbon

[Read our contributing guide][contributing]

## Other handy links

[Learn more about Karbon][documentation].

[contributing]: CONTRIBUTING.md
[changelog]: CHANGELOG.md
[documentation]: https://developers.storipress.com