unimonkiez / react-platformula-boilerplate

Start developing a cross platform native app and website!

 React Platformula Boilerplate ·

The ultimate starter-kit to write native and web apps using react!

Checkout my climbing app - Climb Dojo app, which I wrote using this boilerplate.

Features

• Uses react-platformula, which makes writing cross-platform easy

import React, { Component } from 'react';
import Text from 'react-platformula/text';

export default class HelloWorld extends Component {
  render() {
    return (
      <Text>
        Hello World
      </Text>
    );
  }
}

• Easy usage of svg, fonts and sounds, no more manual linking! 🔥🔥

import React, { Component } from 'react';
import Block from 'react-platformula/block';
import { getCustom as getCustomText } from 'react-platformula/text';
import punkFontFamily from './punk-font.ttf';
import lightTap from './light-tap.mp3';
import getCustomSmiley from './smiley.svg';

const CustomText = getCustomText({
  fontFamily: punkFontFamily,
  fontSize: 30,
  color: 'red',
});

const CustomSmiley = getCustomSmiley({
  width: 20,
  height: 20,
  fill: 'blue',
});

export default class Button extends Component {
  handlePress() {
    lightTap.play();
  }

  render() {
    const { text } = this.props;
    return (
      <Block onPress={() => this.handlePress()}>
        <CustomSmiley />
        <CustomText>
          Click me for sound
        </CustomText>
      </Block>
    );
  }
}

• Uses webpack with a single and easy configure file, you can add support for typescript, flow or whatever you like!

• Use .web, .ios, .android extensions (or any of the globals __WEB__, __IOS__, __ANDROID__) to write code for a specific platform.

Installation

• Make sure you installed react-native's dependencies (such as java, xcode) check their tutorial if needed.
• run npm i (or yarn).
• You are now ready to use the boilerplate!
  to make it your own do the fellowing steps
  • Change app.json name and display name.
  • Change registered component name too in src/index.js.
  • If you need to keep the ejected projects (some libraries linking is manual 😩), just remove them from .gitignore file.

Usage

• npm start, npm run start:web - Start website on localhost:8090.
• npm run start:android - Install and start on android.
• npm run start:ios - Install and start on ios.
• npm run serve:android - Start packager for android, if no need to install.
• npm run serve:ios - Start packager for ios, if no need to install.
• npm run lint[:report][:error][:fix] - Run lints usings eslint, recommand to install eslint-plugin on your editor.
• npm run test[:watch] - Run unit tests, uses jest.
• npm run create:android:release - Create release APK.
• npm run build[:web][:ios][:android] - To make a minified build, needed for web and ios. As for android it is already used within create:android:release.