Get Enyo


The best way to get started with Enyo is to grab an Enyo Bootplate project template. The Bootplate template provides a complete starter project containing the latest release of Enyo core and the most common libraries, and supports source control and cross-platform deployment out of the box.

The simplest way to get a bootplate setup is to use our Yeoman generator. To prepare, install the generator using the Node package manager:

npm install -g generator-enyo

If you prefer, you can either clone bootplate using git, or else download a ZIP containing the template.

Onyx Bootplate for Mobile/Desktop Apps

Get started with the latest Onyx bootplate (for mobile/desktop app development) here:

Onyx Bootplate ZIP Yeoman:
yo enyo MyApp

git clone --recursive

Moonstone Bootplate for TV Apps

Get started with the latest Moonstone bootplate (for TV app development) here:

Moonstone Bootplate ZIP Yeoman:
yo enyo -m=moonstone MyApp

git clone --recursive

Once you've cloned bootplate, open the folder and load debug.html in a browser. Hello to you too, Enyo! When you're ready to dive deeper, head to the Bootplate documentation, or dive into the Developer Guide.

Changing Enyo versions

To update Enyo with Yeoman, simply execute the following:

yo enyo:update -b=

"-b=2.5.1" can include any official version tag or use the "-l" option for the bleeding edge.

Using git, it's easy to upgrade/downgrade the versions of Enyo core and official libraries in your project. Simply run the following command from your bootplate project root to switch versions:

git submodule foreach git checkout

... where "" can be any official version tag, or "master" for the bleeding edge.

Individual Repos from GitHub

Enyo on GitHub

More advanced developers who are contributing to Enyo, developing Enyo libraries, or just prefer to work at the bleeding edge may prefer to pull Enyo and its libraries as independent repos from GitHub.

This is the basic folder structure you should use, and the repos to clone from:

+- enyo
+- lib           (mkdir the lib folder)
   +- onyx
   +- layout
   +- spotlight
   +- moonstone
   +- ...

Nightly Snapshots

Enyo nightly server

We host nightly snapshots of Enyo core and official libraries, as well as the API viewer, Bootplate, and Sampler code. Use this to test your app against the bleeding edge or just see what we're up to, without needing to pull from GitHub. We plan to keep about 2 weeks of archived snapshots available.

Enyo on jsFiddle

Enyo on jsFiddle

jsFiddle is a great service for creating and sharing live snippets of HTML/JS/CSS code. We make the latest stable releases as well as nightly snapshots of Enyo available on jsFiddle, so you can experiment, work up samples, and share them with others. We find it especially useful when filing bug reports or posting to the forums to include a link to a fiddle that reproduces your problem or question. Make sure you select Enyo from the Framework drop down, and use the "no wrap (body)" option.