Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gianlucaguarini/es6-project-starter-kit
Universal Starter Kit to build any javascript ES6 project/library runnable in nodejs and on any browser.
https://github.com/gianlucaguarini/es6-project-starter-kit
Last synced: 2 days ago
JSON representation
Universal Starter Kit to build any javascript ES6 project/library runnable in nodejs and on any browser.
- Host: GitHub
- URL: https://github.com/gianlucaguarini/es6-project-starter-kit
- Owner: GianlucaGuarini
- License: mit
- Created: 2014-07-05T16:51:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-10-08T07:56:33.000Z (almost 7 years ago)
- Last Synced: 2024-04-14T23:57:56.608Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 256 KB
- Stars: 460
- Watchers: 21
- Forks: 55
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Universal Starter Kit to build any javascript ES6 project/library runnable in nodejs and on any browser
====================
[![Build Status][travis-image]][travis-url]
[![Dependency Status][gemnasium-image]][gemnasium-url]
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![Donate][donate-image]][paypal-link]
[![MIT License][license-image]][license-url]
# Introduction
javascript 2015/es6/next introduces a lot of new cool [features](https://babeljs.io/features.html) 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](make.js) file and customizing the tasks in the [tasks](tasks) folder you should be able to develop any kind of javascript project just fitting it to your needs
## javascript ES6
```javascript
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
```
```javascript
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
- [babeljs](https://babeljs.io/)
- [rollup](https://github.com/rollup/rollup)
- [karma](https://github.com/karma-runner/karma)
- [chai](https://github.com/chaijs/chai)
- [eslint](https://github.com/eslint/eslint)
- [sinon](https://github.com/cjohansen/Sinon.JS)
- [serve](https://github.com/tj/serve)
# 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`):
```shell
$ npm install
```
Browsing the [make](make.js) 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
```shell
$ node make # or also `$ npm run default`
```
### Convert the ES6 code into valid ES5 combining all the modules into one single file
```shell
$ node make build # or also `$ npm run build`
```
### Run all the tests
```shell
$ node make test # or also `$ npm run test`
```
### Start a nodejs static server
```shell
$ node make serve # or also `$ npm run serve`
```
### To compile and/or test the project anytime a file gets changed
```shell
$ node make watch # or also `$ npm run watch`
```
# Showcase
List of projects build with `es6-project-starter-kit` :
- [parallax](https://github.com/GianlucaGuarini/parallax)
- [Caronte.js](https://github.com/GianlucaGuarini/Caronte.js)
[npm-url]: https://npmjs.org/package/es6-project-starter-kit
[npm-version-image]: http://img.shields.io/npm/v/es6-project-starter-kit.svg?style=flat-square
[npm-downloads-image]: http://img.shields.io/npm/dm/es6-project-starter-kit.svg?style=flat-square
[gemnasium-image]: https://img.shields.io/gemnasium/GianlucaGuarini/es6-project-starter-kit.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/GianlucaGuarini/es6-project-starter-kit
[travis-url]:https://travis-ci.org/GianlucaGuarini/es6-project-starter-kit
[travis-image]: https://img.shields.io/travis/GianlucaGuarini/es6-project-starter-kit.svg?style=flat-square
[license-url]: LICENSE
[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[paypal-link]:https://www.paypal.me/GianlucaGuarini
[donate-image]:https://img.shields.io/badge/donate-%E2%9D%A4-brightgreen.svg?style=flat-square