From df68a1f55b7d1a8ac3272097199b7d53fbd8603f Mon Sep 17 00:00:00 2001 From: Holly Hudson Date: Wed, 16 Nov 2022 15:55:09 +0100 Subject: [PATCH] initial commit --- .gitignore | 0 LICENSE | 21 +++++++++++++++ README.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++ index.html | 18 +++++++++++++ package.json | 23 ++++++++++++++++ 5 files changed, 138 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 index.html create mode 100644 package.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7b1ba02 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright © 2015 A-Frame. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc6bee6 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +# A-Frame Boilerplate + +Boilerplate for creating WebVR scenes with [A-Frame](https://aframe.io). +This is forked from [this project](https://github.com/aframevr/aframe-boilerplate/) on github. + +Alternatively, check out the [A-Frame Starter on +glitch.com](https://glitch.com/~aframe) for a more interactive way on getting +started. + +## Getting Started + +After downloading the repo, run: + + npm install && npm start + open http://localhost:3000/ + +
+ +> :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.) + +
+ +### Option 3: Fork this CodePen example 🍴💾✒️ + +Or, you can simply __[fork this CodePen example](http://codepen.io/team/mozvr/pen/BjygdO?editors=100)__ to dive right in. Enjoy! + + +## Publishing your scene + +If you don't already know, GitHub offers free and awesome publishing of static sites through __[GitHub Pages](https://pages.github.com/)__. + +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](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). + +
+ +## Still need Help? + +### Installation + +First make sure you have Node installed. + +On Mac OS X, it's recommended to use [Homebrew](http://brew.sh/) to install Node + [npm](https://www.npmjs.com): + + 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/__](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](LICENSE). diff --git a/index.html b/index.html new file mode 100644 index 0000000..ac32a3b --- /dev/null +++ b/index.html @@ -0,0 +1,18 @@ + + + + + Hello, World! - A-Frame + + + + + + + + + + + + + diff --git a/package.json b/package.json new file mode 100644 index 0000000..4c5e368 --- /dev/null +++ b/package.json @@ -0,0 +1,23 @@ +{ + "name": "aframe-hello-world-boilerplate", + "description": "Boilerplate with A-Frame's 'Hello, World!' of WebVR.", + "version": "0.3.0", + "license": "MIT", + "scripts": { + "start": "budo --live --verbose --port 3000 --open", + "deploy": "ghpages", + "ghpages": "ghpages" + }, + "devDependencies": { + "budo": "^7.0.0", + "ghpages": "0.0.3" + }, + "keywords": [ + "aframe", + "aframe-example", + "aframe-boilerplate", + "aframe-scene", + "webvr", + "vr" + ] +}