Academy / Setup and Getting Started / Installing Steroids

Installing-steroids

Installing Steroids



Install the Steroids CLI command-line tools.

To get started with Steroids, you need to install the Steroids CLI package, which gives you access to the Steroids command-line tool. The command-line tool is used to create new applications, run a local server that pushes your changes to client devices, bootstrap your app with generators, deploy your app to the cloud and much more.

Step 0: Create a free AppGyver account

If you haven't already, you need to create a free AppGyver account.

Step 1: Install the Required Tools

First, you need to make sure that you have some tools set up that are required by certain third party Node.js libraries that the Steroids CLI uses:

  • Git (certain libraries download some of their assets from Git repositories)
    • On Windows, be sure to select the "Use Git from Windows Command Prompt" option in the install wizard.
  • Python v2.7 or higher
    • On Windows, be sure to select the "Add python.exe to Path" feature in the install wizard.
    • On OS X, Python should be preinstalled. You can check your version by running $ python in the Terminal.
  • OS X only: Xcode 5 with Command Line Tools (for code compilation)
    • Note that the Command Line Tools are not installed by default. To install the Command Line Tools, open Terminal and type:
      $ xcode-select --install
      A pop-up window will appear asking whether you want to install the Tools. Click Install.

Step 2: Install NVM and Node.js

Next, you need to have Node.js version 0.10.x (or 0.11.x) and npm package management installed.

On Windows, install Node.js with the official Windows installer.

On OS X and Linux, the best way to install Node.js is with Node Version Manager (NVM). Install NVM with the command:

$ curl https://raw.github.com/creationix/nvm/master/install.sh | sh

On some Linux distributions, the sh command might fail. See instructions on manually installing NVM at Steroids Guides.

After installing NVM, restart your Terminal to make sure that NVM is loaded properly. (The NVM install script adds the path definition by default to .bash_profile, so if you are running a different shell, you might need to copy the line manually to your shell's config file.)

To install Node.js version 0.10.x with NVM and set it as default:

$ nvm install 0.10
$ nvm use 0.10
$ nvm alias default 0.10

Alternatively, if you don't want to use NVM, you can install Node.js and npm package management from nodejs.org, though Steroids officially supports only NVM-based installations. Note that for a non-NVM-based Node.js installation, you might need to prepend sudo to certain npm commands (e.g. global installs and updates).

Check that you have the correct version of Node.js installed by running:

$ node -v

Step 3: Install the Steroids CLI package

Install the Steroids CLI package globally (so it can be used in any folder) with the -g option:

$ npm install steroids -g
Note:
npm might give you a few alerts about some third party libraries. This doesn't affect Steroids. If npm fails to install a third party library and gives an error, it can typically be fixed just by running the $ npm install steroids -g command again.

(If you're on Windows, note that Node.js doesn't support Cygwin at the moment.)

Step 4: Connect the Steroids CLI with your AppGyver account

To see that everything works correctly, open a Terminal window and type:

$ steroids login

Steroids opens up a browser window to handle the login process. If you haven't already, log in with your AppGyver account. Then, switch back to the Terminal window. Steroids should tell you that the login was successful.

For more robust information on installing the Steroids CLI, please see the Installing Steroids CLI guide at AppGyver Guides.

Step 5: Build your first Steroids app in 5 minutes

Next, head on over to the Hello World tutorial and get your first app up and running in under 5 minutes.

You can also click below to see all available Steroids lessons in AppGyver Academy, or check out the AppGyver Developer Portal for API docs, in-depth guides and more.

If you run into any trouble, drop us a line at the forums – and happy hacking!


Discussion

Comments for this blog entry


Something missing?


Request material >

Go to forums >