Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.06 KB

README.md

File metadata and controls

91 lines (64 loc) · 2.06 KB

Airfoil Schematics

Airfoil Schematics

React Native boilerplate templates for the Airfoil CLI.

Templates

All templates have some common libraries baked into them such as React Navigation and React Native Config.

BLIMP

A minimalist app built on Axios and the Context API.

JET

A turbocharged starter-kit using Apollo Client and GraphQL.

Common Built-In Features

  • Sane Prettier Defaults

  • Typescript enabled by default

  • Opinionated Directory Structure

    .
└── app/
    ├── components/
    ├── hooks/
    ├── navigation/
    ├── screens/
    ├── services/
    ├── utils/
    ├── App.tsx
    ├── constants.ts
    └── global.d.ts

  • Relative local imports

    import HomeScreen from '@app/screens/HomeScreen'

  • ErrorBoundary already set up

  • First React Navigation route already set up

  • React Native Config hooked up to load .env vars into app/constants.ts

Development

Install base dependencies, and install dependencies for any template(s) you wish to run/test.

# install dev dependencies - needed only for global testing
yarn install

# install all templates
yarn install-templates

# install a specific template
yarn install-blimp
yarn install-jet

Then, to run a template:

yarn ios-blimp
yarn ios-jet
yarn android-blimp
yarn android-jet

Testing

# test all templates
yarn test

# test a specific template
yarn test-blimp
yarn test-jet

Contributing

To contribute, open a new pull request and tag someone as a reviewer.

Make sure all tests are passing.

Issues

All feature requests, bug reports, questions, etc. welcome! Please submit issues here.