Giter Club home page Giter Club logo

karbon-draft's Introduction

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:

karbon-draft's People

Contributors

helloalexpan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

karbon-draft's Issues

Make Karbon backend agnostic

In its initial release, Karbon deploys to nearly all cloud providers, but requires Storipress as its backend.

This issue keeps track of tasks that must be done to make Karbon as backend agnostic as possible.

  • Issue 1
  • Issue 2
  • Issue 3

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.