A-Frame Starter Kit: Create your first "Hello World" WebVR scene
Branch: master
Clone or download
Pull request Compare This branch is 21 commits behind aframevr:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.md
index.html
package.json

README.md

A-Frame Boilerplate

Boilerplate for creating WebVR scenes using A-Frame.

Getting Started

There are two easy options for obtaining this A-Frame scene. It's then up to you to make it your own!

Option 1: Download the ZIP kit 📦

After you have downloaded and extracted this .zip file containing the contents of this repo, open the resulting directory, and you'll be have your scene ready in these few steps:

npm install && npm start

Option 2: Fork this Git repo 🍴

Alternatively, you can fork this repo to get started, if you'd like to maintain a Git workflow.

After you have forked this repo, clone a copy of your fork locally and you'll be have your scene ready in these few steps:

git clone git@github.com:your_username/aframe-boilerplate.git
cd aframe-boilerplate && npm install && npm start

Option 3: Fork this CodePen example

Or, you can simply fork this CodePen example to dive right in. Enjoy!

Publishing your scene

If you don't already know, GitHub offers free and awesome publishing of static sites through [https://pages.github.com/](GitHub Pages).

To publish your scene to your personal GitHub Pages:

npm run deploy

And, it'll now be live at http://your_username.github.io/ :)


To know which GitHub repo to deploy to, the deploy script first looks at the optional repository key in the package.json file (see npm docs for sample usage). If the repository key is missing, the script falls back to using the local git repo's remote origin URL (you can run the local command git remote -v to see all your remotes; also, you may refer to the GitHub docs for more information).


Still need Help?

Installation

First make sure you have Node installed.

On Mac OS X, it's recommended to use Homebrew to install Node + npm:

brew install node

To install the Node dependencies:

npm install

Local Development

To serve the site from a simple Node development server:

npm start

Then launch the site from your favourite browser:

http://localhost:3000/

If you wish to serve the site from a different port:

PORT=8000 npm start

License

This program is free software and is distributed under an MIT License.