Repository files navigation

Boilerplate for creating WebVR scenes withA-Frame.

Alternatively, check out theA-Frame Starter onglitch.com for a more interactive way on gettingstarted.

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

After you havedownloaded 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 startopen http://localhost:3000/

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

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

git clone https://github.com/aframevr/aframe-boilerplate.gitcd aframe-boilerplate && rm -rf .git && npm install && npm startopen http://localhost:3000/

📱Mobile pro tip: Upon starting the development server, the URL will be logged to the console. Load that URL from a browser on your mobile device. (If your mobile phone and computer are not on the same LAN, consider usingngrok for local development and testing.Browsersync is also worth a gander.)

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

If you don't already know, GitHub offers free and awesome publishing of static sites throughGitHub Pages.

To publish your scene to your personal GitHub Pages:

npm run deploy

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

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

First make sure you have Node installed.

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

brew install node

To install the Node dependencies:

npm install

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

This program is free software and is distributed under anMIT License.