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

Commit 900eeb8

Browse files
committed
chore: quickstart rebooted - now the source code for the QS in docs
1 parent f1ef6a8 commit 900eeb8

File tree

247 files changed

+305
-47632
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+305
-47632
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
node_modules
1+
typings/
2+
node_modules/
3+
*.js
4+
*.js.map

LICENSE

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
Copyright 2010-2015 Google, Inc. http://angularjs.org
1+
The MIT License (MIT)
22

3-
Licensed under the Apache License, Version 2.0 (the "License");
4-
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at
3+
Copyright (c) 2016 IdeaBlade
64

7-
http://www.apache.org/licenses/LICENSE-2.0
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
811

9-
Unless required by applicable law or agreed to in writing, software
10-
distributed under the License is distributed on an "AS IS" BASIS,
11-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12-
See the License for the specific language governing permissions and
13-
limitations under the License.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,55 @@
1-
# Angular 2 Quickstart
1+
# Angular 2 QuickStart Source
22

3-
The Angular 2 quickstart includes all of the dependencies for writing Angular 2 in your browser.
3+
This repository holds the TypeScript source code of the [angular.io quickstart](https://angular.io/docs/ts/latest/quickstart.html),
4+
the foundation for most of the documentation samples and potentially a good starting point for your application.
45

5-
The quickstart contains
6-
- Pre-built ES5 version of [Angular 2](https://www.npmjs.com/package/angular2) alpha-14
7-
- Pre-built ES5 version of [rtts-assert](https://www.npmjs.com/package/rtts-assert) alpha-7
8-
- The es6-shim, which includes Traceur, ES6 Module Loader, System, Zone, and Traceur options for meta-data annotations.
6+
## Create a new project based on the QuickStart
7+
8+
Clone this repo into new project folder (e.g., `my-proj`).
9+
```bash
10+
$ git clone https://github.com/angular/quickstart my-proj
11+
$ cd my-proj
12+
```
13+
14+
We have no intention of updating the source on `angular/quickstart`.
15+
Discard everything "git-like" by deleting the `.git` folder.
16+
```bash
17+
$ rm -rf .git
18+
```
19+
20+
### Create a new git repo
21+
You could [start writing code](#start-development) now and throw it all away when you're done.
22+
If you'd rather preserve your work under source control, consider taking the following steps.
23+
24+
Initialize this project as a *local git repo* and make the first commit:
25+
```bash
26+
$ git init
27+
$ git add .
28+
$ git commit -m "Initial commit"
29+
```
30+
31+
Create a *remote repository* for this project on the service of your choice.
32+
33+
Grab its address (e.g. *`https://github.com/<my-org>/my-proj.git`*) and push the *local repo* to the *remote*.
34+
```bash
35+
$ git remote add origin <repo-address>
36+
$ git push -u origin master
37+
```
38+
### Start development
39+
40+
Install the npm packages described in the `package.json` and verify that it works:
41+
42+
```bash
43+
$ npm install
44+
$ npm start
45+
```
46+
You're ready to write your application.
47+
48+
Remember the npm scripts in `package.json`:
49+
50+
* `npm start` - runs the compiler and a server at the same time, both in "watch mode".
51+
* `npm run tsc` - runs the TypeScript compiler once.
52+
* `npm run tsc:w` - runs the TypeScript compiler in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them.
53+
* `npm run lite` - runs the [lite-server](https://www.npmjs.com/package/lite-server), a light-weight, static file server, written and maintained by [John Papa](John Papa) with excellent support for Angular apps that use routing.
54+
* `npm run typings` - runs the typings tool.
55+
* `npm run postinstall` - called by *npm* automatically *after* it successfully completes package installation. This script installs the TypeScript definition files this app requires.

angular2/angular2.js

Lines changed: 0 additions & 41 deletions
This file was deleted.

angular2/angular2.js.map

Lines changed: 0 additions & 1 deletion
This file was deleted.

angular2/annotations.js

Lines changed: 0 additions & 17 deletions
This file was deleted.

angular2/annotations.js.map

Lines changed: 0 additions & 1 deletion
This file was deleted.

angular2/change_detection.js

Lines changed: 0 additions & 138 deletions
This file was deleted.

0 commit comments

Comments
 (0)