Skip to content
/ karbon-draft Public template

Vue + Nuxt based framework for building dynamic custom publications. [PUBLIC DRAFT, FULL FRAMEWORK TO BE PORTED MARCH]

License

Notifications You must be signed in to change notification settings

storipress/karbon-draft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Karbon 2

Version License Downloads

📚 Docs | 🗣 Slack | 💬 Discussions | 📝 Changelog

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?

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
  • 🔦 Instant-search, baked in
  • 🌮 Recommended articles out of the box, with extensible custom logic
  • ∞ SEO friendly infinite scroll
  • 💳 Paywall, checkout and card management
  • 💸 One central config file for all Google Publisher Tags + Prebid (optional) placements
  • 🪠 One provider component that handles all the “plumbing” (viewability, load order prioritisation) w/ googletag + pbjs
  • 💤 Ads SSR optimised + lazy load support (even for Prebid), individually configurable per ad slot
  • 😱 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
  • 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 ⬇️

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:

  1. Start a development server
# Using `yarn`
yarn install
yarn dev

# Using `npm`
npm i
npm run dev
  1. 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: