getting-started.html

---
layout: default
title: Getting started
slug: getting-started
lead: "A quick walkthrough to install and start using CleverStack"
---

  <!-- Install CleverStack
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="install-cleverstack">Install CleverStack</h1>
    </div>

    <p class="lead">Setup is made easy using our CleverStack Command Line Interface (CLI).</p>
      {% highlight bash %}$ npm install -g cleverstack-cli{% endhighlight %}

    <p><strong>Important:</strong> Linux or Mac users may need to run this command using "sudo"</p>
      {% highlight bash %}$ sudo npm install -g cleverstack-cli{% endhighlight %}

  </div>

  <!-- Create a new Project
  ================================================== -->
  <div class="bs-docs-section" style="padding-top: 0px;">
    <div class="page-header">
      <h1 id="create-a-new-project">Create a new project</h1>
    </div>

    <p class="lead">To create a new project using the CleverStack CLI.</p>
      {% highlight bash %}$ clever init my-app{% endhighlight %}
       {% highlight bash %}$ cd my-app{% endhighlight %}
       {% highlight bash %}$ clever install clever-orm clever-auth clever-users clever-accounts clever-roles{% endhighlight %}
       Replace clever-orm with clever-odm if you are using a NoSQL database.

    <p><strong>Note:</strong> These commands may take awhile depending on your internet connection and computer specifications.</p>
  </div>

  <!-- Start serving
  ================================================== -->
  <div class="bs-docs-section" style="padding-top: 0px;">
    <div class="page-header">
      <h1 id="start-serving">Start serving</h1>
    </div>

    <p class="lead">To start your development servers using the CleverStack CLI.</p>
      {% highlight bash %}$ cd my-app{% endhighlight %}
      {% highlight bash %}$ clever serve{% endhighlight %}

    <p>You are now <strong>serving</strong> http requests, open your web browser:</p>
      {% highlight bash %}http://localhost:9000{% endhighlight %}

    <p>From here we recommend visiting our <a href="/documentation">Documentation</a></p>
  </div>