November Perfect Moustache

    es6-project-starter-kit

    7.0.0 • Public • Published

    Universal Starter Kit to build any javascript ES6 project/library runnable in nodejs and on any browser

    Build Status Dependency Status NPM version NPM downloads Donate MIT License

    Introduction

    javascript 2015/es6/next introduces a lot of new cool features unfortunately not yet available in the current modern browsers. This starter kit contains all the tools you need to let you run your ES6 code on any kind of platform.

    Philosophy

    Just use what you really need

    This project doesn't rely on any build system tool like gulp, grunt, duo... By using the make file and customizing the tasks in the tasks folder you should be able to develop any kind of javascript project just fitting it to your needs

    javascript ES6

     
    import helpers from './helpers/helpers'
     
    /**
     * @class
     * An awesome script
     */
    class Greeter {
      constructor(name = 'Dear Coder', text = 'hi there') {
        this.name = name
        this.text = text
      }
      get message() {
        return `${this.text} ${this.name}!`
      }
      set message(text) {
        this.text = helpers.trim(text)
      }
    }
     
    export default Greeter
    var greeter = new Greeter()
     
    console.log(greeter.message) // -> "hi there Dear Coder!"
    // these white spaces will be trimmed
    greeter.message = '   goodbye         '
    console.log(greeter.message) // -> "goodbye Dear Coder!"
     

    Tools available

    Usage

    Once you've downloaded the files in this repo please run the following command in your terminal from the project folder (it may require sudo):

    $ npm install

    Browsing the make file you will find all the available terminal commands to compile/test your project. This file contains also the script name used for the output All the build tasks available are based on the native javascript promises so you will be able to chain and combine them as you prefer

    If you have installed correctly all the nodejs modules you can start writing your javascript modules into the src folder of course using the awesome javascript es6 syntax.

    Available tasks

    Build and test

    $ node make # or also `$ npm run default` 

    Convert the ES6 code into valid ES5 combining all the modules into one single file

    $ node make build # or also `$ npm run build` 

    Run all the tests

    $ node make test # or also `$ npm run test` 

    Start a nodejs static server

    $ node make serve # or also `$ npm run serve` 

    To compile and/or test the project anytime a file gets changed

    $ node make watch # or also `$ npm run watch` 

    Showcase

    List of projects build with es6-project-starter-kit :

    Install

    npm i es6-project-starter-kit

    DownloadsWeekly Downloads

    3

    Version

    7.0.0

    License

    MIT

    Last publish

    Collaborators

    • gianlucaguarini