diff --git a/scripts/README.md b/scripts/README.md index a714c06e36..5d7c60466e 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,5 +1,6 @@ # Development + ### Building & Running Ionic Source 1. `npm install` @@ -7,6 +8,7 @@ 3. Go to [http://localhost:8000/dist/e2e/](http://localhost:8000/dist/e2e/) 4. Stay cool + ### Building & Running Component Demos 1. Clone the `ionic-site` repo in `ionic2/dist/`: `git clone git@github.com:driftyco/ionic-site.git` @@ -17,18 +19,27 @@ 5. A browser should launch at `http://localhost:3000` at which point you can navigate to `http://localhost:3000/docs/v2/components/` +### Building & Running API Demos + +1. Follow the steps for [Building & Running Ionic Source](#building--running-ionic-source) +2. Run `gulp demos` +3. Run `gulp watch:demos` +4. Navigate to `http://localhost:8000/dist/demos` + + ### Building API Docs + 1. `gulp docs` to build the nightly version 2. `gulp docs --doc-version=2.0.0` to build a specific API version - ### Running Snapshot 1. Install [Protractor](https://angular.github.io/protractor/#/): `npm install -g protractor` 2. Export `IONIC_SNAPSHOT_KEY` (get from someone) 3. Run `gulp snapshot` + ### Running Tests 1. `gulp karma`