Wondering what’s next for npm?Check out our public roadmap! »

    coffeekraken-compile-server

    1.0.11 • Public • Published

    Coffeekraken Compile Server

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

    Table of content

    1. Install
    2. Get Started
    3. Documentatopm
    4. Contribute
    5. Who are Coffeekraken?
    6. 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:

    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...

    Install

    npm i coffeekraken-compile-server

    DownloadsWeekly Downloads

    18

    Version

    1.0.11

    License

    MIT

    Unpacked Size

    203 kB

    Total Files

    38

    Last publish

    Collaborators

    • avatar