docs: update docs for 1.0.0 (#1034)

This commit is contained in:
Lex Zhukov 2017-04-28 15:31:26 +03:00 committed by Alexander Zhukov
parent 6e89e797a8
commit 72ab016e75
13 changed files with 107 additions and 100 deletions

View file

@ -17,7 +17,7 @@ If you don't have any of these tools installed already, you will need to:
* Download and install [git](https://git-scm.com/)
* Download and install nodejs [https://nodejs.org](https://nodejs.org)
**Note**: Make sure you have Node version >= 4.0 and NPM >= 3
**Note**: Make sure you have Node version >= 6.0 and NPM >= 3
## Clone repository and install dependencies
You will need to clone the source code of ng2-admin GitHub repository:
@ -31,6 +31,12 @@ After the repository is cloned, go inside of the repository directory and instal
cd ng2-admin
npm install
```
or
```bash
cd ng2-admin
yarn
```
This will setup a working copy of ng2-admin on your local machine.
## Running local copy
@ -41,18 +47,20 @@ To run a local copy in development mode, execute:
npm start
```
Go to http://0.0.0.0:3000 or http://localhost:3000 in your browser.
Go to http://0.0.0.0:4200 or http://localhost:4200 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
npm run start:prod
```
or in AOT mode
```bash
npm run start:prod:aot
```
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)