Aerocube-WebApp

Travis CI Repo Page

Getting Started

File Structure

/app - application files
|  /components - react components that are not redux store connected
|  /constants - javascript files containing constants
|  /containers - react components that are redux store connected and pages that are not redux store connected
|  /services - data fetching services
|  /tests - tests for basic infrastructure files outside of other folders
|  /translations - basic framework for multi-language support
|  /utils - utilities
|  app.js - handles outermost component hierarchy and structural implmentation of routing, redux store and saga flows, etc.
|  global-styles.js - globally applied styles
|  index.html - entrypoint to application, only HTML file
|  reducers - infrastructure for redux reducers
|  routes - infrastructure for route definitions and implementation
|  store - infrastructure for redux store implementation
/docs -- legacy documentation from mxstbr/react-boilerplate
/internals -- structural implmentation for build tools, generator functions, etc. 
/server -- implementation of the local development server and hot-reloading 

Prerequisites

1. Install Node 6.x.x (Latest version) and add to path (you may need to reboot for it to take effect, also installing node added it to my path AT)
2. Install Jetbrains Webstorm

Instructions

1. Open webstorm, click check out from Version Control

2. Login with your github credentials, select this repo

3. Install necessary node global packages

   $ npm install -g firebase-tools
   

   $ npm install -g yarn
   

4. Open a terminal window in the project directory, run the node package manager install. This will use the package.json file in the root of the project directory to install dependencies

   $ yarn
   

5. See various md files in the docs folder for information about commands, generators, and other intracies of this codebase.

6. To run a development build with a hot-reloading server configuration, run

   $ yarn run start
   

7. Be aware that hot-reloading is not perfect, at times it will refuse to recognize changes to the codebase. If this happens, press ctrl-c in the console to cancel the instance and re-run the development server. Happy coding!

Testing

Commits will be sent to Travis CI.

Testing should be done on your local machine prior to a commit, using the following:

$ yarn run test

Building

It takes one command to build the package into chunked, bundled js files and assets.

$ yarn run build