Skip to content
This repository has been archived by the owner on Sep 14, 2018. It is now read-only.

tiaanduplessis/bolt-starter

Repository files navigation

UNMAINTAINED - ⚡ Bolt


Rapid starter for your next React Native project



Built with ❤︎ by Tiaan and contributors

Table of Contents

Table of Contents
  • Motivation
  • Uses
  • Install
  • Usage
  • API
  • Others
  • Contribute
  • License
  • Motivation

    There are many great starter projects for React Native. This one is used in production at Full Facing and comes with a logical setup to let you hit the ground running. It includes a basic todo application example.

    Uses

    This starter relies on many great modules, including:

    • React Native Elements - React Native Elements UI Toolkit
    • React Navigation - Start quickly with built-in navigators that deliver a seamless out-of-the box experience.
    • React Native Animatable - Standard set of easy to use animations and declarative transitions for React Native
    • React Native Device Info - Device Information for React Native iOS and Android
    • Jest - Painless JavaScript Testing
    • lodash - A modern JavaScript utility library delivering modularity, performance & extras.
    • MobX - Simple, scalable state management
    • CodePush - Push code updates to your apps, instantly
    • JavaScript Standard Style - One JavaScript Style Guide to Rule Them All
    • Husky - Git hooks made easy
    • code-notes - Tool to summarise all code annotation like TODO or FIXME

    Install

    Using CLI

    You can install the bolt-starter-cli globally. Running the bolt-starter command will then clone the repo, install all the dependencies and rename the project to the name you specify:

    $ npm install -g bolt-starter-cli

    Or

    yarn global add bolt-starter-cli

    Then run bolt-starter with your new project name:

    $ bolt-starter BestAppEver

    Cloning

    You can also just clone the repo:

    $ git clone https://github.com/tiaanduplessis/bolt-starter.git

    Then cd into it and install the dependencies:

    $ yarn # npm i

    Post Install

    If everything goes off smoothly you should be able to run the project.

    $ react-native run-ios

    Or

    $ react-native run-ios

    Others

    This starter project may not be exactly what your looking for and there are some amazing alternatives. I recommend you check out:

    Contribute

    Contributions are welcome. Please open up an issue or create PR if you would like to help out.

    Note: If editing the README, please conform to the standard-readme specification.

    License

    Licensed under the MIT License.