React Redux Aframe Boilerplate
A modern boilerplate for developing virtual reality content on the web
This boilerplate was modified from redux-easy-boilerplate A-Frame is a fantastic framework for building VR contents, be sure to check the official examples.
Table of Contents
About
- Aframe
- Aframe-react
- Aframe-text-component
- React
- Redux
- React Router
- Babel
- Bootstrap-loader (configurable with .bootstraprc)
- Sass modules (sass-loader css-loader style-loader)
- react transform
- redux-logger
- react-document-meta
- redux-form
- redux-simple-router
- karma
- mocha
Installation
$ git clone https://github.com/HeartRunner/react-redux-aframe-boilerplate.git
$ cd react-redux-aframe-boilerplate
$ npm install
Development
$ npm start
Runs the project in development mode with hot-reloading of src
folder.
Open your browser at http://localhost:3000.
Contribution
Before push commit make sure that all modules are added in package.json
Try
$ rm -rf node_modules
$ npm i
$ npm start
Clean
$ npm run clean
Using rimraf clean the dist
folder, which is the target of the build
Build & build:production
$ npm run build
Builds the app into the 'dist' folder for deployment
$ npm run build:production
clean the dist
folder and rebuilds the app for deployment
Production
To run your server in production simply place the index.html
and dist
folder into
your web root
.
In development mode the app uses hashHistory
(e.g /#/home?_k=x928123) which
keeps track of your currently location on and the state of the page. It is adviced
for production to use browserHistory
instead of hashHistory
To make this change edit src/index.js
the use of history push api requires that all your requests point to index.html
since react-router is keeping track of the navigation (e.g this can be done with .htaccess
file at the web root or with nginx
configuration)
Run karma
Test is now implemented yet.
$ npm test