Welcome to the development home for the Peachtree Corners Veterans Monument WebVR experience. The development team is staffed by a rag-tag team of smart STEM-oriented high school students from Peachtree Corners area high schools.
- Stephen Dunlap, Senior
- Jason Yu, Junior
- Abel Abraham, Junior
- Michelle Coker, Junior
- Ethan Howe, Senior
- Drake Howton, Sophomore
- Colin Ryan, Freshman
- Sean Dunlap - Broadcom Ltd.
- Mark Treager - Cornerstone Media Group
Our office space has been donated by Atlanta Tech Park, a curated Tech Accelerator in Peachtree Corners:
- Nashlee Young - Emnovate / Atlanta Tech Park
- Robin Beinfait - Emnovate / Atlanta Tech Park
Interested in contributing? As an open source project, we'd appreciate any help and contributions!
- Invite yourself to the PCVMA Slack channel.
- Search the issue tracker for similar issues.
- Specify information about your browser and system (e.g., "Firefox Nightly on OS X")
- Describe the problem in detail (i.e., what happened and what you expected would happen).
- If possible, provide a small test case with CodePen, a link to your application, and/or a screenshot. You can fork this sample pen.
- Have a GitHub account with [SSH keys][ssh] set up.
- Fork the repository on GitHub.
- Clone your fork of the repository locally (i.e.,
git clone git@github.com:yourusername/WebVR). - Run
npm installto get dependencies andnpm run devto serve the test examples. - Create a branch to work in (i.e.,
git checkout -b mybranch). - Make changes to your fork of the repository, commit them, and push them (i.e.,
git add -A . && git commit -m 'My Changes (fixes #1234)' && git push origin mybranch). - If necessary, write unit tests ([guide][testing-guide]) and run with
npm test. - [Submit a pull request][pr] to the master branch. If you head to the master repository after running
git pushfrom earlier, you should see a pop up to submit a pull request. - Address review comments if any.
- Help respond to newly-filed GitHub issues
- Redirect developers to [Stack Overflow][stackoverflow] if a question is filed rather than an issue.
- For extra points, cross-post and answer the question on Stack Overflow after redirecting!
There are two easy options for obtaining this A-Frame scene. It's then up to you to make it your own!
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
open http://localhost:3000/
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 https://github.com/Peachtree-Corners-Vetereans-Monument/aframe-boilerplate.git
cd aframe-boilerplate && rm -rf .git && npm install && npm start
open 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 using ngrok for local development and testing. Browsersync is also worth a gander.)
Or, you can simply fork this CodePen example to dive right in. Enjoy!
If you don't already know, GitHub offers free and awesome publishing of static sites through 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).
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
To serve the site from a simple Node development server:
npm start
Then launch the site from your favourite browser:
If you wish to serve the site from a different port:
PORT=8000 npm start
This program is free software and is distributed under an MIT License.