coffeekraken-compile-server

Coffeekraken Compile Server

Provide a simple rest API for compiling js, coffee, sass, scss, etc... files through a node server

Table of content

• Install
• Get Started
• Documentatopm
• Contribute
• Who are Coffeekraken?
• Licence

Install

# using yarn
yarn add coffeekraken-compile-server --dev

# using npm
npm install coffeekraken-compile-server --save-dev

Get Started

Define a script inside your package.json to launch the compile server.

{
	"scripts": {
		"compile-server": "coffeekraken-compile-server [options]"
	}
}

Launch your compile server:

# using yarn
yarn run compile-server

# usin npm
npm run compile-server

Import the API into your javascript file like so:

import compileServer from 'coffeekraken-compile-server'

// make a js compilation
const myCoolJsCode = `
	console.log("hello world")
`
compileServer.compile(myCoolJsCode, 'js').then((compiledCode) => {
 	// do something here...
});

// make a scss compilation
const myCoolScssCode = `
	.hello {
		.world {
			background: red;
		}
	}
`
compileServer.compile(myCoolScssCode, 'scss').then((compiledCode) => {
 	// do something here...
});

Documentation

Here's the documentation list:

• Setup : Setup the JS api
• Compile : Send some code to the compile server
• Settings : Available options

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:

• Share the love ❤️
• Declare issues
• Fix issues
• Add features
• 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...