ngx-admin/docs/contents/articles/002-installation-guidelines/index.md
Geoffrey Roguelon a30c41a11d Replace bower packages by NPM packages.
In the issue akveo/ng2-admin#162, search should be made to be sure of non regression.
2016-08-18 12:45:44 -05:00

2.1 KiB

title author sort group template
Installation Guidelines vl 500 Quick Start 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.

Install tools

If you don't have any of these tools installed already, you will need to:

Note: Make sure you have Node version >= 4.0 and NPM >= 3

Once you have those, you should install these globals with npm install --global:

  • webpack
npm install --global webpack
  • webpack-dev-server
npm install --global webpack-dev-server
  • typings
npm install --global typings
  • typescript
npm install --global typescript

Clone repository and install dependencies

You will need to clone the source code of ng2-admin GitHub repository:

git clone https://github.com/akveo/ng2-admin.git

After repository is cloned, go inside of the repository directory and install dependencies:

cd ng2-admin
npm install

This will setup a working copy of ng2-admin on your local machine.

Note: If you have any issues after the installation, additionally run the following:

typings install

Running local copy

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.

To run the local copy in production mode and build the sources, execute:

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