There are currently plans for this repository to be the canonical
aframe.
A-Frame is a library for creating virtual reality web experiences.
- Virtual Reality: Drop in the library and have a WebVR scene within a few lines of markup.
- Based on the DOM: Manipulate with JavaScript, use with your favorite libraries and frameworks.
- Entity-Component System: Use the entity-component system for better composability and flexibility.
Find out more:
Install from npm:
npm install aframe-core
Then require:
require('aframe-core');
To work locally:
git clone https://github.com/aframevr/aframe-core.git
cd aframe-core
npm install
To start the local development server:
npm start
And fire up http://localhost:9001!
To have the URL open after the server starts:
OPEN=1 npm start
To enable live reloading (i.e., automatic page refreshing upon any file changes):
OPEN=1 LIVE=1 npm start
After cloning and installing, to run tests:
npm test
To see helpful logs, warnings, and errors, enable logging from the console of your favorite developer tools:
localStorage.logs = 1
To disable:
localStorage.logs = 0
Ensure you have cloned the repo and installed the dependencies.
While making changes to aframe-core and testing with another project, link the projects together.
When you are in the directory of your aframe-core repo checkout:
npm link
When you are in the directory of your aframe repo checkout:
npm link aframe-core
npm unlink when you are done testing things and want to use the npm-published versions, not your versions that are locally linked.
From your aframe-core directory:
npm unlink
From your aframe directory:
npm unlink aframe-core
Publishing to npm
To increment the preminor version of the package (e.g., 0.1.19 to 0.1.20) and create a git tag (e.g., v0.1.20):
npm run release:bump
NOTE: npm versions cannot be unpublished.
Once the package is 100% ready to go, to push the new version to npm (e.g., 0.1.20) and to the new tag to GitHub (e.g., v0.1.20):
npm run release:push
npm run dist
git commit -am 'Bump dist'
To publish to https://aframevr.github.io/aframe-core/:
npm run ghpages
To publish to https://your_username.github.io/aframe-core/:
npm run ghpages your_username
This program is free software and is distributed under an MIT License.