scroller-123 v0.0.0

Angular2 Webpack starter kit

An Angular 2 starter kit featuring Angular 2 ,scss,D3,jQuery,ng2-bs, Karma, Protractor, Jasmine, TypeScript, and Webpack by AngularClass.

This seed repo serves as an Angular 2 starter for anyone looking to get up and running with Angular 2 and TypeScript fast. Using a Webpack for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests.

• Best practices in file and application organization for Angular 2.
• Ready to go build system using Webpack for working with TypeScript.
• Angular 2 examples that are ready to go when experimenting with Angular 2.
• A great Angular 2 seed repo for anyone who wants to start their project.
• Testing Angular 2 code with Jasmine and Karma.
• end-to-end Angular 2 code using Protractor.

Quick start

Clone/Download the repo

# clone our repo
git clone https://github.com/Schlumberger/ng2-webpack.git

# change directory to our repo
cd ng2-webpack

# install the repo with npm
npm install

# start the server
npm start 

go to http://localhost:3000 in your browser

Table of Contents

• File Structure
• Getting Started
  • Dependencies
  • Installing
  • Running the app

File Structure

We use the component approach in our starter. This is the new standard for developing Angular apps and a great way to ensure maintainable code by encapsulation of our behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:

angular2-webpack-starter/
 ├──src/                                   * our source files that will be compiled to javascript
 |   ├──bootstrap.ts                       * our entry file for our browser environment
 │   │
 |   ├──vendor.ts                          * our vendor file
 │   │
 │   ├──app/                               * WebApp: folder
 │   │   ├──app.spec.ts                    * a simple test of components in app.ts
 │   │   ├──app.ts                         * App.ts: a simple version of our App component components
 │   │   └──bootstrap.ts                   * entry file for app
 │   │
 │   └──public/                            * static assets are served here
 │       ├──favicon.ico                    * replace me with your own favicon.ico
 │       ├──service-worker.js              * ignore this. Web App service worker that's not complete yet
 │       ├──robots.txt                     * for search engines to crawl your website
 │       ├──human.txt                      * for humans to know who the developers are
 │       │
 │       └──index.html                     * Index.html: where we place our script tags
 │
 ├──test/                                  * this is our global unit tests and end-to-end tests
 │
 ├──spec-bundle.js                         * ignore this magic that sets up our angular 2 testing environment
 ├──karma.config.js                        * karma config for our unit tests
 ├──protractor.config.js                   * protractor config for our end-to-end tests
 ├──tsconfig.json                          * config that webpack uses for typescript
 ├──typings.json                           * our typings manager
 ├──package.json                           * what npm uses to manage it's dependencies
 └──webpack.config.js                      * our webpack config

Getting Started

Dependencies

What you need to run this app:

• node and npm (brew install node)
• Ensure you're running the latest versions Node v4.1.x+ and NPM 2.14.x+

Once you have those, you should install these globals with npm install --global:

• webpack (npm install --global webpack)
• webpack-dev-server (npm install --global webpack-dev-server)
• karma (npm install --global karma-cli)
• protractor (npm install --global protractor)
• typings (npm install --global typings)
• typescript (npm install --global typescript)

Installing

• fork this repo
• clone your fork
• npm install to install all dependencies
• typings install to install necessary typings
• npm run server to start the dev server in another tab

Running the app

After you have installed all dependencies you can now run the app. Run npm run server to start a local server using webpack-dev-server which will watch, build (in-memory), and reload for you. The port will be displayed to you as http://localhost:3000 (or if you prefer IPv6, if you're using express server, then it's http://[::1]:3000/).

server

npm run server # or either webpack-dev-server

Other commands

build files

npm run build

watch and build files

npm run watch

run tests

npm run test  # or karma start

run webdriver (for end-to-end)

npm run webdriver-start

run end-to-end tests

# make sure you have webdriver running and a sever for the client app
npm run e2e  # or protractor

Use latest TypeScript compiler

npm install --global typescript