Welcome! Make sure to read the introduction. If you’re ready to go, there are multiple ways of getting started.
Table of Contents
CodePen is a playground for front-end web development. We can edit
live, and share code snippets. This is a fast way to dive in without having to
download or install anything. Just add a
<script> tag to load the latest
version of A-Frame, then create your scene:
Note: VR mode currently won’t work until the
allowvr attribute is added to CodePen’s I-Frames. Make sure the A-Frame
<script> tag is located in the HTML panel above the
The boilerplate contains:
- A simple HTML file that links to the current version of A-Frame of A-Frame
- An optional local development server
- An easy deployment workflow for GitHub Pages to share with the world
We can grab the boilerplate in one of two ways:
In either case, it is important to serve the project using a local server so that assets load properly.
If we want to include the JS build from the CDN, we can drop a
straight into our HTML:
If we want to serve it locally, we can download the JS build:
Note we should serve the project using a local server so that assets load properly.
For more advanced users who want to use their own build steps, we can install through npm:
Then we can just require A-Frame from our app, perhaps built with Browserify or Webpack:
We should develop projects using a local server so that files are properly served. We can either:
- Download the Mongoose application and open it from the same directory as your HTML file.
- Use Node and npm to start the local server with
npm install && npm run start.
If you have npm, you can get started with scene template right from the command
angle, a command line interface for A-Frame: