ngx-admin/articles/002-installation-guidelines/index.html

106 lines
6.1 KiB
HTML
Raw Normal View History

2016-05-25 13:42:47 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width">
<meta name="keywords" content="admin,dashboard,template,angular,bootstrap,blur,panel,html,css,javascript">
2016-07-12 16:34:59 +03:00
<title>ng2-admin documentation - Installation Guidelines</title>
2016-05-25 13:42:47 +03:00
<link rel="alternate" href="http://localhost:8080/feed.xml" type="application/rss+xml" title="">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900italic,900|Anonymous+Pro:400,700,400italic,700italic&amp;subset=latin,greek,greek-ext,vietnamese,cyrillic-ext,latin-ext,cyrillic">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.min.css">
<link rel="stylesheet" href="/ng2-admin/css/main.css">
<link rel="shortcut icon" href="/ng2-admin/images/favicon.png">
</head>
<body>
<div class="container">
<div class="nav-main">
<div class="wrap"><a href="/ng2-admin/" class="nav-home"><img src="/ng2-admin/images/logo.png" width="24" height="24" class="nav-logo">&nbsp;<span class="blur-label">ng2-</span>admin</a>
<ul class="nav-site nav-site-internal">
<li><a href="/ng2-admin/">Home</a></li>
<li><a href="/ng2-admin/articles/001-getting-started/" class="active">Docs</a></li>
</ul><span class="nav-docs-right">Need some help? Let us know! <a href="mailto:contact@akveo.com">contact@akveo.com</a></span>
</div>
</div>
<section class="content wrap documentationContent">
<div class="nav-docs">
<div class="nav-docs section">
2016-07-28 17:26:09 +03:00
<h5>Quick Start</h5>
2016-05-25 13:42:47 +03:00
<ul>
<li><a href="/ng2-admin/articles/001-getting-started/">Getting Started</a></li>
<li><a href="/ng2-admin/articles/002-installation-guidelines/" class="active">Installation Guidelines</a></li>
</ul>
</div>
<div class="nav-docs section">
2016-07-28 17:26:09 +03:00
<h5>Customization</h5>
2016-05-25 13:42:47 +03:00
<ul>
<li><a href="/ng2-admin/articles/011-changing-color-scheme/">Changing Color Scheme</a></li>
<li><a href="/ng2-admin/articles/014-switch-to-blur-theme/">Enabling blur theme</a></li>
<li><a href="/ng2-admin/articles/012-project-structure/">Project Structure</a></li>
<li><a href="/ng2-admin/articles/013-create-new-page/">Create New Page</a></li>
</ul>
</div>
<div class="nav-docs section">
2016-07-28 17:26:09 +03:00
<h5>Components</h5>
2016-05-25 13:42:47 +03:00
<ul>
<li><a href="/ng2-admin/articles/016-spinner/">Theme Spinner</a></li>
<li><a href="/ng2-admin/articles/015-sidebar/">Sidebar</a></li>
</ul>
</div>
</div>
<div class="inner-content">
<h1>Installation Guidelines</h1>
<div class="subHeader"></div><h2 id="prerequisites">Prerequisites</h2>
2016-09-20 11:36:39 +03:00
<p>Although ng2-admin can be run without any development experience, it would be much easier if you already have some.
2017-02-28 14:37:20 +03:00
The following instructions allow you to run a local copy on your<span class="widont">&nbsp;</span>machine.</p>
<h2 id="install-tools">Install tools</h2>
<p>If you dont have any of these tools installed already, you will need<span class="widont">&nbsp;</span>to:</p>
2016-05-25 13:42:47 +03:00
<ul>
<li>Download and install <a href="https://git-scm.com/">git</a></li>
<li>Download and install nodejs <a href="https://nodejs.org">https://nodejs.org</a></li>
</ul>
2017-04-28 16:56:56 +03:00
<p><strong>Note</strong>: Make sure you have Node version &gt;= 6.0 and <span class="caps">NPM</span> &gt;=<span class="widont">&nbsp;</span>3</p>
2017-02-28 14:37:20 +03:00
<h2 id="clone-repository-and-install-dependencies">Clone repository and install<span class="widont">&nbsp;</span>dependencies</h2>
<p>You will need to clone the source code of ng2-admin GitHub<span class="widont">&nbsp;</span>repository:</p>
2016-05-25 13:42:47 +03:00
<pre><code class="lang-bash">git <span class="built_in">clone</span> https://github.com/akveo/ng2-admin.git
</code></pre>
2017-02-28 14:37:20 +03:00
<p>After the repository is cloned, go inside of the repository directory and install<span class="widont">&nbsp;</span>dependencies:</p>
2016-05-25 13:42:47 +03:00
<pre><code class="lang-bash"><span class="built_in">cd</span> ng2-admin
npm install
</code></pre>
2017-04-28 16:56:56 +03:00
<p>or</p>
<pre><code class="lang-bash"><span class="built_in">cd</span> ng2-admin
yarn
</code></pre>
2017-02-28 14:37:20 +03:00
<p>This will setup a working copy of ng2-admin on your local<span class="widont">&nbsp;</span>machine.</p>
<h2 id="running-local-copy">Running local copy</h2>
<p>To run a local copy in development mode,<span class="widont">&nbsp;</span>execute:</p>
2016-10-13 16:27:42 +03:00
<pre><code class="lang-bash">npm start
</code></pre>
2017-04-28 16:56:56 +03:00
<p>Go to <a href="http://0.0.0.0:4200">http://0.0.0.0:4200</a> or <a href="http://localhost:4200">http://localhost:4200</a> in your<span class="widont">&nbsp;</span>browser.</p>
2017-02-28 14:37:20 +03:00
<p>To run the local copy in production mode and build the sources,<span class="widont">&nbsp;</span>execute:</p>
2017-04-28 16:56:56 +03:00
<pre><code class="lang-bash">npm run start:prod
</code></pre>
<p>or in <span class="caps">AOT</span><span class="widont">&nbsp;</span>mode</p>
<pre><code class="lang-bash">npm run start:prod:aot
2016-05-25 13:42:47 +03:00
</code></pre>
2017-04-28 19:07:20 +03:00
<p>To create a bundle in production mode,<span class="widont">&nbsp;</span>execute:</p>
<pre><code class="lang-bash">npm run build:prod
</code></pre>
<p>or</p>
<pre><code class="lang-bash">npm run build:prod:aot
</code></pre>
2016-09-20 11:36:39 +03:00
<p>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 <code>dist</code> folder and use it with any backend framework or
2017-02-28 14:37:20 +03:00
simply put it under a web<span class="widont">&nbsp;</span>server.</p>
2016-05-25 13:42:47 +03:00
</div>
</section>
<footer class="wrap">
2017-04-28 16:56:56 +03:00
<div class="left">Powered by Angular, Bootstrap 4, Angular CLI and many more...</div>
<div class="right">© 2017 Akveo LLC<br />Documentation licensed under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.</div>
2016-05-25 13:42:47 +03:00
</footer>
</div><a href="https://github.com/akveo/ng2-admin" title="Star &amp; Fork on GitHub" class="github-fork-ribbon"></a>
</body>
</html>