Go to file

Naomi Black 3b8d9dd43a chore(fixes): fix cheatsheet routing and a typo closes #561		2015-12-16 12:24:45 -08:00
.vscode	QuickStart replaced by Getting Started (TS/JS) versions	2015-10-14 21:41:51 -07:00
public	chore(fixes): fix cheatsheet routing and a typo	2015-12-16 12:24:45 -08:00
tools	docs: fix JS plunker generation for beta	2015-12-15 13:04:51 -08:00
.gitignore	chore(cleanup): remove generated files from the repository	2015-12-15 19:34:40 -08:00
LICENSE	Apache 2.0 License	2015-03-11 04:28:24 -07:00
README.md	chore(README): describe the different `sync-and-...` gulp tasks	2015-11-14 12:53:23 -08:00
firebase.json	chore(fixes): fix cheatsheet routing and a typo	2015-12-16 12:24:45 -08:00
gulpfile.js	fix gulp check-deploy to run build-docs first	2015-12-14 23:14:30 -08:00
harp.json	docs(harp): add bio for Topher Fangio	2015-11-13 16:46:57 +00:00
package.json	chore(doc-gen): upgrade to use TypeScript 1.7.3	2015-12-09 12:18:33 +00:00

README.md

Angular.io

Angular.io is currently the preview site for Angular 2. This site also includes links to other helpful angular resources including Angular 1, Angular Material, and AngularFire.

How you can help

Development Setup

install nvm
clone this repo and angular on the same parent directory
cd into root directory angular.io/
make sure you are using the latest node and npm by running nvm use 4.
install local packages by running npm install

Local server with watches and browser reload

cd into root directory angular.io/
run gulp serve-and-sync
browser will launch on localhost:3000 and stay refreshed automatically.

If you are only going to work on a specific part of the docs, such as the API or dev guide, then you can use one of the more specific gulp tasks to only watch those parts of the file system:

serve-and-sync : watch all the local Jade/Sass files, the API source and examples, and the dev guide files
serve-and-sync-api-docs : watch only the API source and example files
serve-and-sync-devGuide : watch only the dev guide files
build-and-serve : watch only the local Jade/Sass files

Technology Used

Angular 1.x: The production ready version of Angular
Angular Material: An implementation of Material Design in Angular.js
Harp: The static web server with built-in preprocessing.
Sass: A professional grade CSS extension language
Normalize: A modern, HTML5-ready alternative to CSS resets
Grids: A highly customizable CSS Grid Framework built with Sass
Prettify: A JS module and CSS for syntax highlighting of source code snippets.
Icomoon: Custom built icon fonts