Skip to content
This repository has been archived by the owner on Oct 25, 2023. It is now read-only.

Latest commit

 

History

History
124 lines (91 loc) · 2.85 KB

README.md

File metadata and controls

124 lines (91 loc) · 2.85 KB
Raw

React Native Boilerplate by Tarmac

Tech stack

Requirements

NOTE: The environment for this was done with macOS 10.14.X

  • Node >= 10 (LTS)
  • NPM or Yarn (Optional)
  • Watchman
  • XCode
  • Android Studio

Project Architecture

Dir Structure

All code of the app exist into the app directory, all files or folders outside of this directory are configuration files except the android and ios directories.

- android/
- ios/
- app/
    - assets/
    - components/
    - routes/
    - screens/
    - state/
    - App.tsx
- common/
    - http/
    - utils/
- config/
- declarations/
- environments/
- storybook/

The Redux Store it's contained under the state directory, into of this must exist a directory for each module in the store with some minimal files and others optional.

Redux Architecture

In a module of the state, must exist some minimal files and others optionals:

_ _duck.ts (Required)
- actions.ts (Required)
- index.ts (Required)
- reducer.ts (Required)
- sagas.ts (Optional)
- selectors.ts (Optional)
- services.ts (Optional)
- types.ts (Required)
  • _duck: Module definition.
  • actions: Definitions of bindings with actions creators of the state.
  • index: Initial point of the module and export.
  • reducer: Definitions of mutations in the state using the actions creators defined in the types.
  • types: Definitions of types of actions possibles in the state.

Environments

You should create minimal two .env.* files in the environments directory.

  • .env.dev
  • .env.storybook

In these you should replicate the vars in the file .env.template with the correct values.

How to start the boilerplate

  • Clone this repository:
$> git clone https://github.com/tarmac/rn-boiler-ts
  • Inside the project run:
$> rm -rf .git/
$> git init
$> yarn
$> yarn renameApp <NewNameOfTheApp> -b "[domain].[company].[project]"

Android & iOS

Development

The platform in the command bellow must be one of android or ios

$> yarn run:[platform]

Storybook

$> yarn run:[platform]-storybook

NOTE: It's automatically start the metro server.

Contribute

Please contribute with ideas on GH issues or create PR to improve this repository.

Thanks.