ziggyJ / react-cordova-boilerplate

TodoMVC example for react with development tools to build a cordova application

Redux DevTools TodoMVC example

Why cordova

Cordova is really simple to build cross platform mobile applications for any of your needs, this boilerplate provides a great starting point for your next project, as it uses:

• Cordova
• ES6
• React
• React router
• Webpack
• Server rendering
• Karma
• Eslint
• Style: Redium + SASS

Installing

1. Install dependencies: npm i
2. Install global tools: npm install -g cordova
3. Add your cordova platform by running cordova platform add %PLATFORM% (android and more)

Usage

• npm run lint - runs linting against src folder.
• npm run test - runs karma + jasmine testing.
• npm run start - starts a server, with react model replacement and devtools.
• npm run start:prod - starts a server, with react model replacement and minifications of main html file and js file.
• npm run build - builds the project (single html file and single js file) as it does for development.
• npm run build:prod - builds the project (single html file and single js file) as it does for production.

Build and run as application

As you do with any cordova application, cordova build android, cordova run android and more.

cordova runs npm run build:prod before any cordova command (using hooks).

Style practice

To style your html, simply inline style your DOM (here is why).

You can use Radium (which is included) to easily add 'css like' event listeners to your components (like hover).

Sass/CSS is included to complete some of the missing features or already written style you want to use. To use Sass/CSS simply import that file!

custom-font.scss

@font-face {
	font-family: 'custom-font';
	src:url('./custom-font.eot') format('embedded-opentype'),
		url('./custom-font.ttf') format('truetype'),
		url('./custom-font.woff') format('woff'),
		url('./custom-font.svg') format('svg');
	font-weight: normal;
	font-style: normal;
}
.customFont {
  font-family: 'custom-font';  
  &.customFontIcon {
    content: "\e600";
    &:hover {
      color: blue;
    }
  }
}

ExampleComponent.jsx

import React, { Component } from 'react';
import customFont from './custom-font.scss'

export default class ExampleComponent extends Component {
  render() {
    return (
      <div style={{backgroundColor: 'red'}}>
        Hello world!
        <span className={customFont.customFont + ' ' + customFont.customFontIcon}></span>
      </div>
      );
  }
}

Advantages:

• Complete styling ability to go with inline style.
• Easily use third party styles.
• No globals - when including the style to the needed place when can minify the classes much further (like .a instead of .customFont).

Sass style will be minified, bundled and included to the server rendered file.