Provide a nice code playground that let you play with some html, javascript (coffee, typescript, etc...) and css (sass, scss, stylus, etc...)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.resources
bin
doc
public
tests
.babelrc
.editorconfig
.gitignore
.node-version
.travis.yml
CHANGELOG.md
LICENSE.txt
README.md
code-playground.config.js
package-lock.json
package.json
tests.config.js
webpack.config.js
yarn.lock

README.md

Coffeekraken Code Playground

Provide a nice code playground that let you play with some html, javascript (coffee, typescript, etc...) and css (sass, scss, stylus, etc...)

Carpenter screenshot

Features

  • Nice web interface to play with your code live
  • Support sass/stylus/es6/coffeescript/typescript compilation through the compile-server package
  • Nicely display information from the package.json file
  • Support multiple "apps" that run on the same code-playground server
  • Support multiple layouts like : top / right / bottom / left / vertical / horizontal

Table of content

  1. Demo: http://components.coffeekraken.io
  2. Install
  3. Get Started
  4. Documentation
  5. Browsers support
  6. Contribute
  7. Who are Coffeekraken?
  8. Licence

Install

npm install coffeekraken-code-playground --save-dev

Get Started

#### Config file

Create a code-playground.config.js file at the root of your project like this one:

module.exports = {
	title : 'Hello World',
	port : 3000,
	editors : {
		html : {
			data : `
				<h1>Hello World</h1>
			`
		},
		css : {
			language : 'sass',
			data : `
				body {
					background: red;
				}
			`
		},
		js : {
			data : `
				console.log('hello world');
			`
		}
	}
};

See documentation for full code-playground.config.js file reference

Add an NPM script

Add in your package.json file a demo script like so:

{
	"scripts": {
		"demo": "coffeekraken-code-playground"
	}
}

Launch your code-playground

Launch the NPM script to start your code-playground server like so:

npm run demo

Documentation

## Browsers support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
IE11+ last 2 versions last 2 versions last 2 versions

As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

## Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...