Skip to content
This repository was archived by the owner on Feb 17, 2024. It is now read-only.

Commit 8bed931

Browse files
committed
docs(readme): include typescript instructions
1 parent 1e21a85 commit 8bed931

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# angular2-webpack-seed
2-
A starter kit featuring Angular 2, TypeScript, and Webpack by [AngularClass](https://angularclass.com)
2+
A starter kit featuring Angular 2, Router, TypeScript, and Webpack by [AngularClass](https://angularclass.com)
3+
4+
## Use latest TypeScript compiler
5+
TypeScript 1.5 beta includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.
6+
7+
$ npm install -g typescript@^1.5.0-beta
8+
39

410
### install
511
```bash
@@ -10,19 +16,36 @@ $ npm install
1016

1117
### server
1218
```bash
13-
$ webpack-dev-server
19+
$ npm run server
1420
```
1521

1622
### auto build files
1723
```bash
18-
$ webpack --watch
24+
$ npm run watch
1925
```
2026

27+
28+
## .d.ts Typings
29+
The typings in `typings/angular2/` are partially autogenerated, partially hand
30+
written. All the symbols should be present, but probably have wrong paramaters
31+
and missing members. Modify them as you go.
32+
33+
34+
## Use a TypeScript-aware editor
35+
We have good experience using these editors:
36+
37+
* [Visual Studio Code](https://code.visualstudio.com/)
38+
* [Webstorm 10](https://www.jetbrains.com/webstorm/download/)
39+
* [Atom](https://atom.io/) with [TypeScript plugin](https://atom.io/packages/atom-typescript)
40+
* [Sublime Text](http://www.sublimetext.com/3) with [Typescript-Sublime-Plugin](https://github.com/Microsoft/Typescript-Sublime-plugin#installation)
41+
42+
43+
2144
### Todo
2245
* hot-component-reloading
2346

2447

25-
<br><br><br>
48+
<br><br>
2649

2750
[![AngularClass](https://angularclass.com/images/ng-crown.svg "Angular Class")](https://angularclass.com)
2851
##[AngularClass](https://angularclass.com)

0 commit comments

Comments
 (0)