An open API service indexing awesome lists of open source software.

https://github.com/editvr/editvr-frontend

Editorial frontend, driven by EditVR's API.
https://github.com/editvr/editvr-frontend

aframe react vr webvr

Last synced: about 1 year ago
JSON representation

Editorial frontend, driven by EditVR's API.

Awesome Lists containing this project

README

          

editvr-frontend


CircleCI Documented with emdaer Commitizen friendly


Editorial frontend, driven by EditVR’s API.


Requirements



  • Node.js (See package.json:engines for correct version).

  • Yarn


Setup



  • Clone this repository.

  • In this repository’s root folder, run: yarn.

  • To start the dev server, run: yarn start.


Configuration


In the ./src/config folder, you will see production.json and development.json files. These contain configuration for editvr-frontend, feel free to adjust as needed.


Testing


This project makes use of Jest and Enzyme. Test files should be located in the same directory as the component the test file is testing, or in the __test__ directory.



  • To watch files and run tests: yarn test.

  • To see test coverage reports: yarn coverage.


For more information about tests on this project, please read this documentation:



For OSX users


You may need to install Watchman to support create-react-app’s testing utilities. If you end up seeing EMFILE: too many open files errors, run: brew update ; brew install watchman.


Deployment


This project is automatically deployed when changes are merged from the develop branch into the master branch.



  • To generate a production build: yarn build.

  • To deploy EditVR: yarn deploy.


Contributing


The process around contributing to this codebase and the workflow by which code changes are proposed and accepted into this project are documented here.


Contributors


EditVR is brought to you with love by Four Kitchens.

Contributors




Patrick Coffey






Adam Erickson






James Todd






Randy Oest






Luke Herrington






Jeff Tomlinson






Mike Minecki






Allan Chappell


License


editvr-frontend is GPL-3.0 licensed.