https://github.com/flukeout/farewell-ricardo
Aframe VR test - butterfly catching game
https://github.com/flukeout/farewell-ricardo
Last synced: 3 months ago
JSON representation
Aframe VR test - butterfly catching game
- Host: GitHub
- URL: https://github.com/flukeout/farewell-ricardo
- Owner: flukeout
- License: mit
- Created: 2016-05-20T19:57:07.000Z (about 9 years ago)
- Default Branch: gh-pages
- Last Pushed: 2016-05-27T16:29:37.000Z (about 9 years ago)
- Last Synced: 2025-01-11T10:19:56.174Z (5 months ago)
- Language: HTML
- Size: 5.12 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 📦
[
](https://github.com/aframevr/aframe-boilerplate/archive/master.zip)
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:
npm install && npm start
open http://localhost:3000/
### Option 2: Fork this Git repo 🍴🐙
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.
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:
git clone https://github.com/aframevr/aframe-boilerplate.git
cd aframe-boilerplate && rm -rf .git && 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 __[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](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).