javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(): move dev readme to scripts dir

Browse Source
This commit is contained in:
Adam Bradley
2015-10-20 14:29:17 +01:00
parent 7725aaa8a7
commit 9bcf8bfa3f
2 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -18,34 +18,6 @@ We are also building out a number of starter projects, including the Ionic 2 sta
[https://github.com/driftyco/ionic2-starter](https://github.com/driftyco/ionic2-starter)
### Building & Running Ionic Source
1. `npm install`
2. `gulp watch`
3. Go to [http://localhost:8000/e2e/](http://localhost:8000/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`
* You may need to remove the existing directory first: `rm -rf ionic2/dist/ionic-site`
2. Run `gulp demos:all` from the top level directory
3. Navigate to `ionic2/dist/ionic-site` and run `npm install`
4. Run `gulp watch` in this directory
5. A browser should launch at `http://localhost:3000` at which point you can navigate to `http://localhost:3000/docs/v2/components/`
6. Any time you make a change to the demos repeat step 2
### 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`
### Distribution
- [npm: ionic-framework](https://www.npmjs.com/package/ionic-framework)

28
scripts/README.md Normal file
View File

@@ -0,0 +1,28 @@
# Development
### Building & Running Ionic Source
1. `npm install`
2. `gulp watch`
3. Go to [http://localhost:8000/e2e/](http://localhost:8000/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`
* You may need to remove the existing directory first: `rm -rf ionic2/dist/ionic-site`
2. Run `gulp demos:all` from the top level directory
3. Navigate to `ionic2/dist/ionic-site` and run `npm install`
4. Run `gulp watch` in this directory
5. A browser should launch at `http://localhost:3000` at which point you can navigate to `http://localhost:3000/docs/v2/components/`
6. Any time you make a change to the demos repeat step 2
### 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`