├── package.json ├── index.html ├── .gitignore ├── LICENSE └── README.md /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "aframe-hello-world-boilerplate", 3 | "description": "Boilerplate with A-Frame's 'Hello, World!' of WebVR.", 4 | "version": "0.3.0", 5 | "license": "MIT", 6 | "scripts": { 7 | "start": "budo --live --verbose --port 3000 --open", 8 | "deploy": "ghpages", 9 | "ghpages": "ghpages" 10 | }, 11 | "devDependencies": { 12 | "budo": "^7.0.0", 13 | "ghpages": "0.0.3" 14 | }, 15 | "keywords": [ 16 | "aframe", 17 | "aframe-example", 18 | "aframe-boilerplate", 19 | "aframe-scene", 20 | "webvr", 21 | "vr" 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Hello, World! - A-Frame 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.sw[mnop] 3 | 4 | # Logs 5 | logs 6 | *.log 7 | npm-debug.log* 8 | 9 | # Runtime data 10 | pids 11 | *.pid 12 | *.seed 13 | *.pid.lock 14 | 15 | # Directory for instrumented libs generated by jscoverage/JSCover 16 | lib-cov 17 | 18 | # Coverage directory used by tools like istanbul 19 | coverage 20 | 21 | # nyc test coverage 22 | .nyc_output 23 | 24 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 25 | .grunt 26 | 27 | # node-waf configuration 28 | .lock-wscript 29 | 30 | # Compiled binary addons (http://nodejs.org/api/addons.html) 31 | build/Release 32 | 33 | # Dependency directories 34 | node_modules 35 | jspm_packages 36 | 37 | # Optional npm cache directory 38 | .npm 39 | 40 | # Optional REPL history 41 | .node_repl_history 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License 2 | 3 | Copyright © 2015 A-Frame. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A-Frame Boilerplate 2 | 3 | Boilerplate for creating WebVR scenes with [A-Frame](https://aframe.io). 4 | 5 | Alternatively, check out the [A-Frame Starter on 6 | glitch.com](https://glitch.com/~aframe) for a more interactive way on getting 7 | started. 8 | 9 | ## Getting Started 10 | 11 | There are two easy options for obtaining this A-Frame scene. It's then up to you to make it your own! 12 | 13 | ### Option 1: Download the ZIP kit 📦 14 | 15 | [](https://github.com/aframevr/aframe-boilerplate/archive/master.zip) 16 | 17 | After you have __[downloaded and extracted this `.zip` file](https://github.com/aframevr/aframe-boilerplate/archive/master.zip)__ containing the contents of this repo, open the resulting directory, and you'll be have your scene ready in these few steps: 18 | 19 | npm install && npm start 20 | open http://localhost:3000/ 21 | 22 |
23 | 24 | ### Option 2: Fork this Git repo 🍴🐙 25 | 26 | Alternatively, you can __[fork this repo](https://github.com/aframevr/aframe-boilerplate/fork)__ to get started, if you'd like to maintain a Git workflow. 27 | 28 | After you have __[forked this repo](https://github.com/aframevr/aframe-boilerplate/fork)__, clone a copy of your fork locally and you'll be have your scene ready in these few steps: 29 | 30 | git clone https://github.com/aframevr/aframe-boilerplate.git 31 | cd aframe-boilerplate && rm -rf .git && npm install && npm start 32 | open http://localhost:3000/ 33 | 34 | > :iphone: **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 using [ngrok](https://ngrok.com/) for local development and testing. [Browsersync](https://www.browsersync.io/) is also worth a gander.) 35 | 36 |
37 | 38 | ### Option 3: Fork this CodePen example 🍴💾✒️ 39 | 40 | Or, you can simply __[fork this CodePen example](http://codepen.io/team/mozvr/pen/BjygdO?editors=100)__ to dive right in. Enjoy! 41 | 42 | 43 | ## Publishing your scene 44 | 45 | If you don't already know, GitHub offers free and awesome publishing of static sites through __[GitHub Pages](https://pages.github.com/)__. 46 | 47 | To publish your scene to your personal GitHub Pages: 48 | 49 | npm run deploy 50 | 51 | And, it'll now be live at __http://`your_username`.github.io/__ :) 52 | 53 |
54 | 55 | To know which GitHub repo to deploy to, the `deploy` script first looks at the optional [`repository` key](https://docs.npmjs.com/files/package.json#repository) in the [`package.json` file](package.json) (see [npm docs](https://docs.npmjs.com/files/package.json#repository) 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](https://help.github.com/articles/about-remote-repositories/) for more information). 56 | 57 |
58 | 59 | ## Still need Help? 60 | 61 | ### Installation 62 | 63 | First make sure you have Node installed. 64 | 65 | On Mac OS X, it's recommended to use [Homebrew](http://brew.sh/) to install Node + [npm](https://www.npmjs.com): 66 | 67 | brew install node 68 | 69 | To install the Node dependencies: 70 | 71 | npm install 72 | 73 | 74 | ### Local Development 75 | 76 | To serve the site from a simple Node development server: 77 | 78 | npm start 79 | 80 | Then launch the site from your favourite browser: 81 | 82 | [__http://localhost:3000/__](http://localhost:3000/) 83 | 84 | If you wish to serve the site from a different port: 85 | 86 | PORT=8000 npm start 87 | 88 | 89 | ## License 90 | 91 | This program is free software and is distributed under an [MIT License](LICENSE). 92 | --------------------------------------------------------------------------------