angular4-testing/ng2-admin/docs/contents/articles/002-installation-guidelines/index.md

1.7 KiB

title author sort group template
Installation Guidelines vl 500 Quick Start article.jade

Prerequisites

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

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

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 the 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.

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 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