Building Blocks for the VR Web
A-Frame is a framework for creating virtual reality web experiences.
Find out more:
To get started immediately, just fire up this CodePen example scene!
To embed this library in your project, include this file:
For the unminified version for local development (with source maps), include this file:
Also, be sure to check out the awesome examples (or the ones in this repository).
First install from npm:
npm install aframe
And in your Browserify/Webpack modules, simply require the module:
require('aframe')
Alternatively, you can clone this repository to work locally on this project and explore the examples.
git clone git@github.com:aframevr/aframe.git
cd aframe && npm install
To start the local development server:
npm start
And fire up http://localhost:9000!
Ensure you have cloned the repo and installed the dependencies.
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
dist Filesnpm run dist
To publish to https://aframevr.github.io/aframe/:
npm run ghpages
To publish to https://your_username.github.io/aframe/:
npm run ghpages your_username
Get involved! Check out the Contributing Guide for how to get started.
This program is free software and is distributed under an MIT License.
0.3.2 (October 12, 2016)
FAQs
A web framework for building virtual reality experiences.
The npm package aframe receives a total of 5,516 weekly downloads. As such, aframe popularity was classified as popular.
We found that aframe demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.