Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/lookfirst/systemjs-seed

SystemJS + ES6 + Angular + React
https://github.com/lookfirst/systemjs-seed

Last synced: 13 days ago
JSON representation

SystemJS + ES6 + Angular + React

Lists

README 

        
[![npm version](https://badge.fury.io/js/systemjs-seed.svg)](https://badge.fury.io/js/systemjs-seed)

[![npm dependencies](https://david-dm.org/lookfirst/systemjs-seed.svg)](https://david-dm.org/lookfirst/systemjs-seed)

[![Build Status](https://travis-ci.org/lookfirst/systemjs-seed.svg)](https://travis-ci.org/lookfirst/systemjs-seed)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lookfirst/systemjs-seed)



# SystemJS + ES6 + AngularJS + React



Seed project for ES6 modules via SystemJS with ES6 syntax using Babel (was: 6to5) that lazy-load and bundle build with AngularJS and React.



# Note!



This project is a bit out of date now due to jspm being a bit of a moving target. I've been slammed with starting a new business and haven't had a chance to keep things up to date. PR's welcome!



## Motivation



For a long time now, I've wanted to create a JavaScript single page app seed project that has the following qualities:



- Treats both unit and e2e testing as first class citizens

- Build file that was easy to understand (more configuration, less code)

- Package manager for installing dependencies, regardless of whether they live on npm or github

- Transpiles code

- Debugging shows me exactly where the error is

- Automatic reloading of the browser when files change

- Minify across routes instead of as a single giant file (with cross route dependencies in their own files)

- Can run in production / minified mode locally for testing

- Ablility to plug in whatever framework of the week

- Imports for everything



Thankfully, after a long wait for the technology to catch up and a lot of blood sweat and tears, this project is alive.



If you like the project, please star / watch it to show your support!



## Features



Based heavily off the *excellent* [angular-systemjs-seed](https://github.com/Swimlane/angular-systemjs-seed) project.



This project does everything the parent project does:



- ES6 Syntax via Babel (was: 6to5) with source maps

- ES6 Modules via SystemJS - No more requirejs!

- Karma / Jasmine unit tests with coverage report

- Lazy-loading modules via routes with AngularJS

- Easy watch/browser-sync/lint/test/build setup via Gulp

- LESS CSS Support with source maps and minification

- AngularJS Template Compilation

- AngularJS ngAnnotate

- Bundle builds via SystemJS Builder

- Cache Busting with SystemJS

- Demonstrates on-demand CSS theme loading

- Demonstrates the [systemjs-route-bundler](https://github.com/Swimlane/systemjs-route-bundler) route bundler



But wait, there's more!



- Built from a [Yeoman generator](https://github.com/lookfirst/generator-systemjs) for reproducible project builds

- Adds example [TodoMVC app](https://github.com/lookfirst/systemjs-seed/tree/master/src/app/todo/) (with [unit](https://github.com/lookfirst/systemjs-seed/tree/master/test-unit/app/todo) and [e2e](https://github.com/lookfirst/systemjs-seed/tree/master/test-e2e/app/todo) tests!)

- Adds support for CoffeeScript (optional)

- Adds support for Facebook React (through [ngReact](https://github.com/davidchang/ngReact))

- Adds example [React app](https://github.com/lookfirst/systemjs-seed/tree/master/src/app/react/)

- Uses [gulp-helpers](https://github.com/lookfirst/gulp-helpers) to DRY the gulpfile

- Adds `run` and `default` gulp targets

- Project is served from the `dist` folder for security

- Fixes a bunch of misc small build file and lint issues

- Override of port number with environment

- index.html is based on a template

- Templates are exported modules and can be referred to by name

- Enables Angular html5Mode by default

- Uses the [karma-babel-preprocessor](https://github.com/babel/karma-babel-preprocessor) to ES6 compile tests inline

- Moves all tests to a separate folder to prevent leakage into `dist`

- Minifies HTML in production

- Runs tests on Travis CI using Karma / PhantomJS and Protractor



## Examples



- This project is an example of using the [Yeoman generator](https://github.com/lookfirst/generator-systemjs/)

- [Module A](https://github.com/lookfirst/module-a) is an example of a couple of simple directives

- [SystemJS Material Start ES6 project](https://github.com/lookfirst/systemjs-material-start) is an example of setting up Material design under this framework



## How to use this project



Use the [Yeoman generator](https://github.com/lookfirst/generator-systemjs/) to create your own seed project. This project is based off the generator. You can use this project as an example to see how all the pieces fit together for your own application. 

### Layout



This should give you an idea of how to get started with building your own project. Most of the effort required will be actually deleting the existing app examples and building your own.



* `package.json::jspm` -- Location of our library dependencies, such as angular. Manage with `jspm install [DEP]`.

* `src/system.config.js` -- Where jspm manages all of its installed dependencies.

* `src/index.tpl.html` -- The main entrypoint for the application. This loads `system.js`, `system.config.js` and the application.

* `src/app/routes.json` -- Declare all of your top level routes here.

* `src/app/app.js` -- Bootstraps angular and is the top level module.

* `src/app/FOLDER` -- Each component of your application should have its own folder.

* `src/app/todo/todo.js` -- Main entrypoint for the todo application. Sets up all the routes directly related to this app, imports the controller, templates, css, etc.

* `src/app/react/exampleApplication.jsx` -- Main entrypoint for the example React application.

* `test-unit` -- Unit tests using Karma/Jasmine/ES6. It has been hard to find examples of good testing practices (especially for angular), so the todo application has very thorough tests for directives and controllers.

* `test-e2e` -- e2e tests using Protractor/Jasmine/ES6.

 

### Install & Run



1. `npm install -g gulp jspm`

2. `npm install`

3. `gulp run`

4. Browse to `http://localhost:9000`



### Tasks



- `gulp test` -- run karma tests using Chrome

- `npm test` -- run karma tests using PhantomJS (for Travis CI)

- `npm run-script protractor-setup; npm run-script protractor-run` -- setup and run protractor (for Travis CI)

- `gulp lint` -- run jshint

- `export SITUATION=production && gulp run` -- bundle, cache bust, minify and run in production mode (great for Heroku)



### Tooling



- [Gulp](http://gulpjs.com/)

- [EditorConfig](http://editorconfig.org/)

- [JSHint](http://jshint.com/install/)

- [Karma](http://karma-runner.github.io)

- [Protractor](http://angular.github.io/protractor/)

- [jspm](http://jspm.io/)

- [Babel](http://babeljs.io/)

- [SystemJS](https://github.com/systemjs/systemjs)

- [AngularJS](http://angularjs.org)

- [React](http://facebook.github.io/react/)

- [ocLazyLoad](https://github.com/ocombe/ocLazyLoad/)

- [Angular UI-Router](https://github.com/angular-ui/ui-router/)



### Best Practices



- https://github.com/johnpapa/angularjs-styleguide

- https://github.com/gocardless/angularjs-style-guide

- http://sett.ociweb.com/sett/settApr2014.html

- http://todomvc.com/examples/angularjs-perf/#/



### Research & Resources



- https://github.com/systemjs/systemjs

- https://github.com/gocardless/es6-angularjs

- http://glenmaddern.com/articles/javascript-in-2015

- https://github.com/marcj/angular-es6-annotations

- https://github.com/robianmcd/angular-next

- https://github.com/ng-next/ng-next-example



### FAQ



Q: I use bower, what happened to it? Can I still use it?



A: jspm is an alternative to bower that is just as functional, but integrates nicely with SystemJS. You can still use bower if you like, but there is no need for it anymore. Bower was originally part of this project, but it has been removed. If you'd like to see what it was like to use it, please see [this commit](https://github.com/lookfirst/systemjs-seed/commit/83c246ee1cabc4e8b3aa2aee49418954e913a1f8) and [this commit](https://github.com/lookfirst/systemjs-seed/commit/377ae05f9425c8969682bf328f207e0dcc8c3c8e).



Q: What about integrating other frameworks like [Ember](http://emberjs.com/) or [Riot](https://muut.com/riotjs/)?



A: Sure! It is just a matter of including the dependencies (using jspm) and using them as you normally would. I'm a fan of Angular, but I realize that React is getting popular too. ngReact is the perfect combination of the DI/Service system of Angular and the component model of React. If you like other frameworks, you are free to use those as well. Pull requests for examples are welcome!