Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/PatrickJS/NG6-starter

:ng: An AngularJS Starter repo for AngularJS + ES6 + Webpack
https://github.com/PatrickJS/NG6-starter

angular1 angularclass angularjs gulp ng6-starter webpack

Last synced: about 2 months ago
JSON representation

:ng: An AngularJS Starter repo for AngularJS + ES6 + Webpack

Awesome Lists containing this project

README 

        


  ng6-starter

  




# NG6 [![Join Slack](https://img.shields.io/badge/slack-join-brightgreen.svg)](https://angularclass.com/slack-join) [![Join the chat at https://gitter.im/angularclass/NG6-starter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/angularclass/NG6-starter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



> The de facto starter repo for building scalable apps with [Angular](https://angularjs.org), [ES6](https://git.io/es6features), and [Webpack](http://webpack.github.io/)



This repo serves as a minimal starter for those looking to get up-and-running with Angular and ES6, using [Gulp](http://gulpjs.com/) and [Webpack](http://webpack.github.io/) for the build process.

**This seed is not a Yeoman generator.** It's a minimal starter with tasks for building the boilerplate. **These are its features**:

* The best practice in directory/file organization for Angular (allowing for infinite horizontal app scaling)

* A ready-to-go build system for working with [ES6](https://git.io/es6features)

* Tasks for generating additional boilerplate Angular components

* A full testing system in place

* [SASS](http://sass-lang.com/) support via node-sass



**Check out the [JSPM version](https://github.com/angularclass/NG6-starter/tree/jspm)--an alternative to Webpack as an ES6 build system.**



> If you're looking for a preliminary [Angular 2](https://angular.io/) build, please use the [angular2-webpack-starter](https://github.com/angularclass/angular2-webpack-starter).

___



# Table of Contents

* [Walkthrough](#walkthrough)

    * [Build System](#build-system)

    * [File Structure](#file-structure)

    * [Testing Setup](#testing-setup)

* [Getting Started](#getting-started)

    * [Dependencies](#dependencies)

    * [Installing](#installing)

    * [Running the App](#running-the-app)

        * [Gulp Tasks](#tasks)

        * [Testing](#testing)

		* [Generating Components](#generating-components)		

* [Starter Kit Support and Questions](#starter-kit-support-and-questions)



# Walkthrough

## Build System

NG6 uses NPM scripts, Gulp, and Webpack together for its build system. Yes, you don't need Gulp if you're using Webpack. This is true if your build system is only responsible for file manipulation. However, ours is not.



`Webpack` handles all file-related concerns:

* Transpiling from ES6 to ES5 with `Babel`

* Loading HTML files as modules

* Transpiling stylesheets and appending them to the DOM

* Refreshing the browser and rebuilding on file changes

* Hot module replacement for transpiled stylesheets

* Bundling the app

* Loading all modules

* Doing all of the above for `*.spec.js` files as well



`Gulp` is the orchestrator:

* Starting and calling Webpack

* Starting a development server (yes, Webpack can do this too)

* Generating boilerplate for the Angular app



**Check out the [JSPM version](https://github.com/angularclass/NG6-starter/tree/jspm)--an alternative to Webpack as an ES6 build system.**



## File Structure

We use a componentized approach with NG6. This will be the eventual standard (and particularly helpful, if using 

Angular's new router) as well as a great way to ensure a tasteful transition to Angular 2, when the time is ripe. 

Everything--or mostly everything, as we'll explore (below)--is a component. A component is a self-contained 

concern--may it be a feature or strictly-defined, ever-present element of the UI (such as a header, sidebar, or 

footer). Also characteristic of a component is that it harnesses its own stylesheets, templates, controllers, routes, 

services, and specs. This encapsulation allows us the comfort of isolation and structural locality. Here's how it 

looks:

```

client

⋅⋅app/

⋅⋅⋅⋅app.js * app entry file

⋅⋅⋅⋅app.html * app template

⋅⋅⋅⋅common/ * functionality pertinent to several components propagate into this directory

⋅⋅⋅⋅components/ * where components live

⋅⋅⋅⋅⋅⋅components.js * components entry file

⋅⋅⋅⋅⋅⋅home/ * home component

⋅⋅⋅⋅⋅⋅⋅⋅home.js * home entry file (routes, configurations, and declarations occur here)

⋅⋅⋅⋅⋅⋅⋅⋅home.component.js * home "directive"

⋅⋅⋅⋅⋅⋅⋅⋅home.controller.js * home controller

⋅⋅⋅⋅⋅⋅⋅⋅home.scss * home styles

⋅⋅⋅⋅⋅⋅⋅⋅home.html * home template

⋅⋅⋅⋅⋅⋅⋅⋅home.spec.js * home specs (for entry, component, and controller)

```



## Testing Setup

All tests are also written in ES6. We use Webpack to take care of the logistics of getting those files to run in the various browsers, just like with our client files. This is our testing stack:

* Karma

* Webpack + Babel

* Mocha

* Chai



To run tests, type `npm test` in the terminal. Read more about testing [below](#testing).



# Getting Started

## Dependencies

Tools needed to run this app:

* `node` and `npm`



## Installing

* `fork` this repo

* `clone` your fork

* `npm install` to install dependencies



## Running the App

NG6 uses Gulp to build and launch the development environment. After you have installed all dependencies, you may run the app. Running `npm start` will bundle the app with `webpack`, launch a development server, and watch all files. The port will be displayed in the terminal.

 

### Tasks

Here's a list of available tasks:

* `npm run build`

  * runs Webpack, which will transpile, concatenate, and compress (collectively, "bundle") all assets and modules into `dist/bundle.js`. It also prepares `index.html` to be used as application entry point, links assets and created dist version of our application.

* `npm run serve`

  * starts a dev server via `webpack-dev-server`, serving the client folder.

* `npm run watch`

  * alias of `serve`

* `npm start` (which is the default task that runs when typing `gulp` without providing an argument)

  * runs `serve`.

* `npm run component`

  * scaffolds a new Angular component. [Read below](#generating-components) for usage details.

  

### Testing

To run the tests, run `npm test`.



`Karma` combined with Webpack runs all files matching `*.spec.js` inside the `app` folder. This allows us to keep test files local to the component--which keeps us in good faith with continuing to build our app modularly. The file `spec.bundle.js` is the bundle file for **all** our spec files that Karma will run.



Be sure to define your `*.spec.js` files within their corresponding component directory. You must name the spec file like so, `[name].spec.js`. If you don't want to use the `.spec.js` suffix, you must change the `regex` in `spec.bundle.js` to look for whatever file(s) you want.

`Mocha` is the testing suite and `Chai` is the assertion library. If you would like to change this, see `karma.conf.js`.



### Examples



It's always easier to learn something if you have an examples. Here is a list of repos which based on this starter:



 - [TodoMVC Example App](https://github.com/AngularClass/NG6-todomvc-starter)



### Generating Components

Following a consistent directory structure between components offers us the certainty of predictability. We can take advantage of this certainty by creating a gulp task to automate the "instantiation" of our components. The component boilerplate task generates this:

```

⋅⋅⋅⋅⋅⋅componentName/

⋅⋅⋅⋅⋅⋅⋅⋅componentName.js // entry file where all its dependencies load

⋅⋅⋅⋅⋅⋅⋅⋅componentName.component.js

⋅⋅⋅⋅⋅⋅⋅⋅componentName.controller.js

⋅⋅⋅⋅⋅⋅⋅⋅componentName.html

⋅⋅⋅⋅⋅⋅⋅⋅componentName.scss // scoped to affect only its own template

⋅⋅⋅⋅⋅⋅⋅⋅componentName.spec.js // contains passing demonstration tests

```



You may, of course, create these files manually, every time a new module is needed, but that gets quickly tedious.

To generate a component, run `npm run component -- --name componentName`.



The parameter following the `--name` flag is the name of the component to be created. Ensure that it is unique or it will overwrite the preexisting identically-named component.



The component will be created, by default, inside `client/app/components`. To change this, apply the `--parent` flag, followed by a path relative to `client/app/components/`.



For example, running `npm run component -- --name signup --parent auth` will create a `signup` component at `client/app/components/auth/signup`.  



Running `npm run component -- --name footer --parent ../common` creates a `footer` component at `client/app/common/footer`.  



Because the argument to `--name` applies to the folder name **and** the actual component name, make sure to camelcase the component names.



# Starter Kit Support and Questions

> Contact us, anytime, regarding anything about this project.



* [Gitter: angularclass/NG6-starter](https://gitter.im/angularclass/NG6-starter)

* [Twitter: @PatrickJS__](https://twitter.com/PatrickJS__)



___



enjoy — **PatrickJS**