An Angular 2 template with Webpack 1 and Typescript 2
- Angular 2 final release,
- TypeScript 2 and type manager with @types,
- Webpack 1,
- Karma,
- Jasmine,
- Coverage with Istanbul and Karma + SourceMapping,
- Protractor (not tested),
- TsLint,
- Codelyzer,
- Hot Module Replacement with Webpack and @angularclass/hmr and @angularclass/hmr-loader,
- TypeDoc (not working with Typescript 2),
This template are based on angular2-webpack-start.
Make sure you have Node version >= 5.0 and NPM >= 3
Clone/Download the repo then edit
app.ts
inside/src/app.module.ts
# clone our repo
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/Romakita/angular2-webpack-template.git
# change directory to our repo
cd angular2-webpack-template
# install the repo with npm
npm install
# start the server
npm start
# use Hot Module Replacement
npm run server:dev:hmr
# if you're in China use cnpm
# https://github.com/cnpm/cnpm
go to http://0.0.0.0:3000 or http://localhost:3000 in your browser.
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/
├──config/ * our configuration
| ├──helpers.js * helper functions for our configuration files
| ├──spec-bundle.js * ignore this magic that sets up our angular 2 testing environment
| ├──karma.conf.js * karma config for our unit tests
| ├──protractor.conf.js * protractor config for our end-to-end tests
│ ├──webpack.dev.js * our development webpack config
│ ├──webpack.prod.js * our production webpack config
│ └──webpack.test.js * our testing webpack config
│
├──src/ * our source files that will be compiled to javascript
│ ├──main.browser.ts * our entry file for our browser environment
│ │
│ ├──index.html * Index.html: where we generate our index page
│ │
│ ├──polyfills.ts * our polyfills file
│ │
│ ├──vendor.ts * our vendor file
│ │
│ ├──components/app/ * WebApp: folder
│ │ ├──app.spec.ts * a simple test of components in app.ts
│ │ ├──app.e2e.ts * a simple end-to-end test for /
│ │ └──app.ts * App.ts: a simple version of our App component components
│ │
│ └──assets/ * static assets are served here
│ ├──icon/ * our list of icons from www.favicon-generator.org
│ ├──css/ * global css folder
│ └──images/ * images folder
│
├──tslint.json * typescript lint config
├──typedoc.json * typescript documentation generator
├──tsconfig.json * config that webpack uses for typescript
├──package.json * what npm uses to manage it's dependencies
└──webpack.config.js * webpack main configuration file
What you need to run this app:
node
andnpm
(brew install node
)- Ensure you're running the latest versions Node
v4.x.x
+ (orv6.x.x
) and NPM3.x.x
+
If you have
nvm
installed, which is highly recommended (brew install nvm
) you can do anvm install --lts && nvm use
in$
to run with the latest Node LTS. You can also have thiszsh
done for you automatically
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
)typescript
(npm install --global typescript
)
fork
this repoclone
your forknpm install webpack-dev-server rimraf webpack -g
to install required global dependenciesnpm install
to install all dependenciesnpm run server
to start the dev server in another tab
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://0.0.0.0:3000
(or if you prefer IPv6, if you're using express
server, then it's http://[::1]:3000/
).
# development
npm run server
# production
npm run build:prod
npm run server:prod
# development
npm run build:dev
# production
npm run build:prod
npm run server:dev:hmr
npm run watch
npm run test
npm run watch:test
# make sure you have your server running in another terminal
npm run e2e
npm run webdriver:update
npm run webdriver:start
npm run webdriver:start
# in another terminal
npm run e2e:live
npm run build:docker
Configuration files live in config/
we are currently using webpack, karma, and protractor for different stages of your application
We have good experience using these editors:
When you include a module that doesn't include Type Definitions inside of the module you can include external Type Definitions with @types
i.e, to have youtube api support, run this command in terminal:
npm i @types/youtube @types/gapi @types/gapi.youtube
In some cases where your code editor doesn't support Typescript 2 yet or these types weren't listed in tsconfig.json
, add these to "src/custom-typings.d.ts" to make peace with the compile check:
import '@types/gapi.youtube';
import '@types/gapi';
import '@types/youtube';
When including 3rd party modules you also need to include the type definition for the module if they don't provide one within the module. You can try to install it with @types
npm install @types/node
npm install @types/lodash
If you can't find the type definition in the registry we can make an ambient definition in this file for now. For example
declare module "my-module" {
export function doesSomething(value: string): string;
}
If you're prototyping and you will fix the types later you can also declare it as type any
declare var assert: any;
declare var _: any;
declare var $: any;
If you're importing a module that uses Node.js modules which are CommonJS you need to import as
import * as _ from 'lodash';