Code Monkey home page Code Monkey logo

es6starterproject's Introduction

ES6 Starter Project

Ready to go ES6 project starter with Tests and Coverage.

Travis build status Build status Coverage Status Maintainability

Requires:

  • NodeJs
  • Gulp

Installation

 git clone https://github.com/iondrimba/es6starterproject.git
 cd es6starterproject
 npm install
 gulp

GOAL:

Reduce time spent by developers looking to work today with all the new ES6 features, it also includes Tests and Coverage. I chose to leave it simple as possible (no MV* Framework dependency).

Features:

  • ES6 ready
  • SemVer (Automated package and files versioning)
  • Router system with pushstate (page.js)
  • Templating engine (handlebars.js)
  • Tests (Jasmine + karma)
  • Coverage (Coveralls)
  • CI (Travis)
  • Module system CommonJs (browserify)

In order to test if Pushstate is working you have to host it on apache so it can reads the .htaccess file

Testing:

  • $ npm test

Includes:

  • ES6 transpile via Babel
  • BrowserSync
  • Browserify
  • Karma
  • SemVer
  • Jasmine
  • Code Coverage
  • Sass
  • ESLint
  • Scss Lint (Requires Ruby and scss-lint)
  • Imagemin (images optimization)
  • Uglify
  • Watch
  • Html-Min
  • Post-Css (autoprefixer)

Gulp Tasks:

  • gulp (default)
  • gulp deploy (run tasks without browser-sync and watch)
  • gulp optimize (run optimization tasks)
  • gulp bump-patch / minor / major (update files with version number)

Semantic Versioning:

The bump-versions tasks should be executed after your deploy and optimize task. The task will:

  1. Rename the file app.js to app.version.js
  2. Rename the file app.css to app.version.css
  3. Will update the index.html with the new file references.

Structure:

├── public/
│    ├─── css/
│    ├─── js/
│    ├─── images/
│    ├─── .htaccess
│    └─── index.html
│
│── spec/(jasmine spec files)
│
│── src/
│    ├── images/
│    ├── scripts/
│	   │    ├─── core/
│	   │    ├─── models/
│	   │    ├─── partials/
│	   │    ├─── views
│	   │    └─── app.js
│	   │
│	   ├── scss/
│	   │    ├─── components/
│	   │    ├─── partials/
│	   │    ├─── views/
│	   │    └─── app.scss
│	   │
│    └── templates/
│
│── tasks/
│
│── .gitignore
│── .travis.yml
│── gulpfile.js
│── karma.conf.js
│── LICENSE
│── lint.yml
│── package.json
└── README.md

es6starterproject's People

Contributors

iondrimba avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.