fix(docs): minor doc fixes

* minor doc fixes

* minor doc fixes

* minor doc fixes

* routing
This commit is contained in:
Joseph Orr 2016-09-19 12:20:34 -04:00 committed by nixa
parent 7c4437bb08
commit c48fd9ed64
8 changed files with 64 additions and 40 deletions

View file

@ -8,7 +8,8 @@ template: article.jade
## Prerequisites
Despite BlurAdmin can be run without any development experience, it would be much easier if you already have some. In general following instructions allow you to run a local copy on your machine.
Although ng2-admin can be run without any development experience, it would be much easier if you already have some.
The following instructions allow you to run a local copy on your machine.
## Install tools
@ -37,10 +38,12 @@ npm install --global typescript@2.0.0
## Clone repository and install dependencies
You will need to clone the source code of ng2-admin GitHub repository:
```bash
git clone https://github.com/akveo/ng2-admin.git
```
After repository is cloned, go inside of the repository directory and install dependencies:
After the repository is cloned, go inside of the repository directory and install dependencies:
```bash
cd ng2-admin
npm install
@ -51,17 +54,23 @@ This will setup a working copy of ng2-admin on your local machine.
## Running local copy
To run a local copy in development mode, execute:
```bash
npm start
```
Go to http://0.0.0.0:3000 or http://localhost:3000 in your browser.
To run the local copy in production mode and build the sources, execute:
```bash
npm run prebuild:prod && npm run build:prod && npm run server:prod
```
This will clear up your dist folder (where release files are located), generate release build and start built-in server.
Now you can copy the sources from a `dist` folder and use it with any backend framework or simply put it under some web server.
For addition information about build, please check out [Angular2 Webpack Starter documentation](https://github.com/AngularClass/angular2-webpack-starter)
This will clear up your dist folder (where release files are located), generate a release build and start the
built-in server.
Now you can copy the sources from the `dist` folder and use it with any backend framework or
simply put it under a web server.
For addition information about creating a build, please check out [Angular2 Webpack Starter documentation](https://github.com/AngularClass/angular2-webpack-starter)