Create amazing 360 and VR content using React
JavaScript C C++ Other
Clone or download
AGS- and facebook-github-bot Cleanup Lint
Differential Revision:
D9213025

hg-to-perforce: landcastle instance https://our.intern.facebook.com/intern/sandcastle/40361821909/1148837579/

fbshipit-source-id: 561478d5d5fb8e46a178f3253d4618de16ecf78d
Latest commit c3e7e7f Aug 7, 2018
Permalink
Failed to load latest commit information.
.github Rename all packages to 360 May 2, 2018
EndToEnd Cleanup Lint Aug 8, 2018
Examples Cleanup Lint Aug 8, 2018
Libraries Upgrade to React 16.3 and RN 55 Jul 23, 2018
OVRUI/fonts Migrate still-used contents of OVRUI into ReactVR, eliminate legacy p… Apr 30, 2018
React360 Cleanup Lint Aug 8, 2018
Samples Add frame loop, sample showing headlocked panels May 15, 2018
defs Implement Text and RawText components around pluggable text Jul 25, 2018
docs Copy over new docs Jun 22, 2018
jest Rename all packages to 360 May 2, 2018
lib-assets Cleanup Lint Aug 8, 2018
packages/react-360-cli Upgrade to React 16.3 and RN 55 Jul 23, 2018
scripts Rename all packages to 360 May 2, 2018
tools Autofix Code Formatting Apr 17, 2018
website Copy over new docs Jun 22, 2018
.eslintignore Rename all packages to 360 May 2, 2018
.eslintrc.json Restructured shadow view structure Jun 27, 2018
.flowconfig Upgrade flow to 0.63 Feb 16, 2018
.gitattributes Initial commit Apr 18, 2017
.gitignore Copy over new docs Jun 22, 2018
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 Rename all packages to 360 May 2, 2018
circle.yml Rename all packages to 360 May 2, 2018
jest-preset.json Rename all packages to 360 May 2, 2018
package.json Upgrade to React 16.3 and RN 55 Jul 23, 2018
yarn.lock Upgrade to React 16.3 and RN 55 Jul 23, 2018

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).

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.