Skip to content
Create amazing 360 and VR content using React
JavaScript C C++ Other
Branch: master
Clone or download
andrewimm and facebook-github-bot Support passing custom text implementations to 360 surfaces
Reviewed By: julian-park

Differential Revision: D15232652

fbshipit-source-id: 0026b42bbc13c5da494966d326a3e974e00a58e2
Latest commit faca8ea May 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Get tests running on Circle CI again Mar 19, 2019
.github Rename all packages to 360 May 2, 2018
EndToEnd Cleanup Lint Aug 8, 2018
Examples Cleanup Lint Aug 8, 2018
Libraries Bring React Dev Tools back to work with React 360 Feb 20, 2019
OVRUI/fonts Migrate still-used contents of OVRUI into ReactVR, eliminate legacy p… Apr 30, 2018
React360 Fix "measureInWindow" doesn't take transform Mar 21, 2019
Samples Provide an alternative way of placing hotspot in TourAppTempalte Mar 21, 2019
addons Move legacy packages to addons folder, make sure everything in packag… May 20, 2019
defs Support adding custom video player Nov 29, 2018
docs Documentation Updates for NonBlobBridge Mar 6, 2019
jest Rename all packages to 360 May 2, 2018
lib-assets Cleanup Lint Aug 8, 2018
packages Support passing custom text implementations to 360 surfaces May 23, 2019
render-tests Add support for non-interleaved vertex buffers Mar 25, 2019
scripts Make using bridge file as Web Worker as default behavior in react-360… Mar 6, 2019
tools Autofix Code Formatting Apr 17, 2018
website Document updates on new examples Dec 14, 2018
.eslintignore Rename all packages to 360 May 2, 2018
.eslintrc.json Restructured shadow view structure Jun 27, 2018
.flowconfig Add pacakge `react-360-common-ui` Dec 14, 2018
.gitattributes Initial commit Apr 18, 2017
.gitignore Migrate All Samples to use bridge Web Worker Mar 6, 2019
CODE_OF_CONDUCT.md Add Code of Conduct Nov 26, 2017
CONTRIBUTING.md Rename all packages to 360 May 2, 2018
LICENSE Rename all packages to 360 May 2, 2018
LICENSE-docs Initial commit Apr 18, 2017
LICENSE-examples Initial commit Apr 18, 2017
PATENTS Rename all packages to 360 May 2, 2018
README.md Allow running packager with 'https' Nov 30, 2018
jest-preset.json Rename all packages to 360 May 2, 2018
lerna.json Add lerna support, fix alpha on canvas Mar 2, 2019
package.json Add lerna support, fix alpha on canvas Mar 2, 2019
yarn.lock Update package information, ensure each package can link to its depen… May 23, 2019

README.md

React 360 npm version Circle CI

React 360 is a framework for the creation of interactive 360 experiences that run in your web browser. It pairs modern APIs like WebGL and WebVR with the declarative power of React, producing applications that can be consumed through a variety of devices. Leveraging web technologies and the existing React ecosystem, React 360 aims to simplify the construction of cross-platform 360 experiences.

Getting Started

We've designed the React 360 developer experience to get your first project up and running in only a few minutes. Before installing the developer tools, you'll need to make sure that you have two prerequisites installed:

  • Node.js version 6.0.0 or higher
  • yarn or npm (>= v3.0.0) package managers

Next, install the React 360 CLI – a command-line tool that generates the basic layout of new projects.

npm install -g react-360-cli

Or

yarn global add react-360-cli

You'll only need to install this CLI once. It will alert you when it's out of date, and provide instruction on how to update it.

Once installed, the CLI can be used to create a new project by running

react-360 init PROJECT_NAME

where PROJECT_NAME is the name of your new application. Once it's been created and the dependencies are installed, change your working directory to PROJECT_NAME, and start the application server by running npm start (or yarn start). You can also use --https option to run the server with https.

When the server has booted, you can access your application by navigating to http://localhost:8081/ in your web browser. Your application's code can be found in index.js, and you can learn more about available framework features by diving into our documentation.

Opening Issues

If you encounter a bug with React 360, let us know. Search the existing issues and try to make sure your problem doesn't already exist before opening a new issue. It's helpful if you include the version of React 360, Browser, and OS you're using. Please include a stack trace and reduced repro case where appropriate.

React 360 is open source software, and we welcome contribution from the wider community. If you are able to fix your bug, or find a way to fix another existing issue, we encourage you to submit a PR to address it.

If you find a documentation typo, please don't file an issue – just create a pull request containing the fix and we will pull it into the documentation.

Contributing

For more information about contributing to React 360, see our Contributor Guidelines.

License

React 360 is BSD licensed. We also provide an additional patent grant.

React documentation is Creative Commons licensed.

Examples provided in this repository and in the documentation are separately licensed.

You can’t perform that action at this time.