Skip to content

Commit

Permalink
Update documentation (#151)
Browse files Browse the repository at this point in the history
* Update README.md

* Update dependencies

* Update getting started

* Update iOS internals

* Update Android internals
  • Loading branch information
svbutko authored Jan 8, 2024
1 parent 671ab50 commit 7cafb0d
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 57 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,40 +18,40 @@
# [Check out docs to get started](https://svbutko.github.io/react-native-template-strong/)

Build primarily with
- [React Native](https://reactnative.dev) `0.72.5`
- [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) `7.37.0`
- [Redux Toolkit](https://redux-toolkit.js.org) `1.9.6`
- [TypeScript](https://www.typescriptlang.org) `5.2.2`
- [React Native](https://reactnative.dev) `0.73.2`
- [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) `7.37.2`
- [Redux Toolkit](https://redux-toolkit.js.org) `2.0.1`
- [TypeScript](https://www.typescriptlang.org) `5.3.3`

Includes next components:
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.0`
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.2`
- [Localization](https://github.com/stefalda/ReactNativeLocalization) `2.3.2`
- [Orientation locker](https://github.com/wonday/react-native-orientation-locker) `1.5.0`
- [Permissions](https://github.com/zoontek/react-native-permissions) `3.9.2`
- [Orientation locker](https://github.com/wonday/react-native-orientation-locker) `1.6.0`
- [Permissions](https://github.com/zoontek/react-native-permissions) `4.0.4`
- [Config](https://github.com/luggit/react-native-config) `1.5.1`
- [Image crop picker](https://github.com/ivpusic/react-native-image-crop-picker) `0.40.0`
- [Image crop picker](https://github.com/ivpusic/react-native-image-crop-picker) `0.40.2`
- [Reanimated carousel](https://github.com/dohooo/react-native-reanimated-carousel) `3.5.1`
- [Vector icons](https://github.com/oblador/react-native-vector-icons) `10.0.0`
- [Vector icons](https://github.com/oblador/react-native-vector-icons) `10.0.3`
- [SF Symbols](https://github.com/birkir/react-native-sfsymbols) `1.2.1`
- [In-app review](https://github.com/MinaSamir11/react-native-in-app-review) `4.3.3`
- [Size matters](https://github.com/nirsky/react-native-size-matters) `0.4.0`
- [Size matters](https://github.com/nirsky/react-native-size-matters) `0.4.2`
- [Mask input](https://github.com/CaioQuirinoMedeiros/react-native-mask-input) `1.2.3`
- [DayJS](https://github.com/iamkun/dayjs/) `1.11.10`
- [Net info](https://github.com/react-native-netinfo/react-native-netinfo) `9.4.1`
- [Share](https://github.com/react-native-share/react-native-share) `9.4.1`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.5.4`
- [Net info](https://github.com/react-native-netinfo/react-native-netinfo) `11.2.1`
- [Share](https://github.com/react-native-share/react-native-share) `10.0.2`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.6.1`
- [Menu](https://github.com/react-native-menu/menu) `0.9.1`

Testing made with:
- [Jest](https://github.com/facebook/jest) `29.7.0`
- [Detox](https://github.com/wix/Detox) `20.12.1`
- [Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react-native/en/get-started/) `6.5.6`
- [Detox](https://github.com/wix/Detox) `20.14.8`
- [Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react-native/en/get-started/) `6.5.7`

Code quality covered with:
- [ESLint](https://github.com/eslint/eslint) `8.50.0`
- [ESLint](https://github.com/eslint/eslint) `8.56.0`
- [ESLint Config React Strong](https://github.com/svbutko/eslint-config-react-strong) `2.2.0`
- [Husky](https://github.com/typicode/husky) `8.0.3`
- [Prettier](https://github.com/prettier/prettier) `3.0.3`
- [Lint staged](https://github.com/okonet/lint-staged) `14.0.1`
- [Prettier](https://github.com/prettier/prettier) `3.1.1`
- [Lint staged](https://github.com/okonet/lint-staged) `15.2.0`

And many other day-to-day useful dependencies.
36 changes: 18 additions & 18 deletions website/docs/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,41 +11,41 @@ Every dependency is provided with types or in case if there are no types it impl
The versions are updating manually and regularly with new releases.

Build primarily with
- [React Native](https://reactnative.dev) `0.72.5`
- [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) `7.37.0`
- [Redux Toolkit](https://redux-toolkit.js.org) `1.9.6`
- [TypeScript](https://www.typescriptlang.org) `5.2.2`
- [React Native](https://reactnative.dev) `0.73.2`
- [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) `7.37.2`
- [Redux Toolkit](https://redux-toolkit.js.org) `2.0.1`
- [TypeScript](https://www.typescriptlang.org) `5.3.3`

Includes next components:
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.0`
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.2`
- [Localization](https://github.com/stefalda/ReactNativeLocalization) `2.3.2`
- [Orientation locker](https://github.com/wonday/react-native-orientation-locker) `1.5.0`
- [Permissions](https://github.com/zoontek/react-native-permissions) `3.9.2`
- [Orientation locker](https://github.com/wonday/react-native-orientation-locker) `1.6.0`
- [Permissions](https://github.com/zoontek/react-native-permissions) `4.0.4`
- [Config](https://github.com/luggit/react-native-config) `1.5.1`
- [Image crop picker](https://github.com/ivpusic/react-native-image-crop-picker) `0.40.0`
- [Image crop picker](https://github.com/ivpusic/react-native-image-crop-picker) `0.40.2`
- [Reanimated carousel](https://github.com/dohooo/react-native-reanimated-carousel) `3.5.1`
- [Vector icons](https://github.com/oblador/react-native-vector-icons) `10.0.0`
- [Vector icons](https://github.com/oblador/react-native-vector-icons) `10.0.3`
- [SF Symbols](https://github.com/birkir/react-native-sfsymbols) `1.2.1`
- [In-app review](https://github.com/MinaSamir11/react-native-in-app-review) `4.3.3`
- [Size matters](https://github.com/nirsky/react-native-size-matters) `0.4.0`
- [Size matters](https://github.com/nirsky/react-native-size-matters) `0.4.2`
- [Mask input](https://github.com/CaioQuirinoMedeiros/react-native-mask-input) `1.2.3`
- [DayJS](https://github.com/iamkun/dayjs/) `1.11.10`
- [Net info](https://github.com/react-native-netinfo/react-native-netinfo) `9.4.1`
- [Share](https://github.com/react-native-share/react-native-share) `9.4.1`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.5.4`
- [Net info](https://github.com/react-native-netinfo/react-native-netinfo) `11.2.1`
- [Share](https://github.com/react-native-share/react-native-share) `10.0.2`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.6.1`
- [Menu](https://github.com/react-native-menu/menu) `0.9.1`

Testing made with:
- [Jest](https://github.com/facebook/jest) `29.7.0`
- [Detox](https://github.com/wix/Detox) `20.12.1`
- [Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react-native/en/get-started/) `6.5.6`
- [Detox](https://github.com/wix/Detox) `20.14.8`
- [Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react-native/en/get-started/) `6.5.7`

Code quality covered with:
- [ESLint](https://github.com/eslint/eslint) `8.50.0`
- [ESLint](https://github.com/eslint/eslint) `8.56.0`
- [ESLint Config React Strong](https://github.com/svbutko/eslint-config-react-strong) `2.2.0`
- [Husky](https://github.com/typicode/husky) `8.0.3`
- [Prettier](https://github.com/prettier/prettier) `3.0.3`
- [Lint staged](https://github.com/okonet/lint-staged) `14.0.1`
- [Prettier](https://github.com/prettier/prettier) `3.1.1`
- [Lint staged](https://github.com/okonet/lint-staged) `15.2.0`

It also includes other small or utility components.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ make sure you have [environment ready to work with](https://reactnative.dev/docs

These are the versions of tools on which this template was created and tested (higher versions should be also supported):

- [Android Studio Giraffe | 2022.3.1 Patch 1](https://developer.android.com/studio)
- Gradle 7.4.2
- JDK 11 (Zulu 11)
- [Android Studio Hedgehog | 2023.1.1 Patch 1](https://developer.android.com/studio)
- Gradle 8.3
- JDK 17 (Zulu 17)
- [XCode 15.0](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
- [Node 20.7.0](https://nodejs.org/)
- npm 10.1.0
Expand Down
19 changes: 8 additions & 11 deletions website/docs/internals/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,21 @@ Enabled

## Proguard

By default `proguard` is enabled, so be careful when installing new native dependencies.
By default `proguard` is disabled

## Versions

Next versions are being used:
- kotlinVersion - `1.5.31`
- buildToolsVersion - `30.0.2`
- minSdkVersion - `21`
- compileSdkVersion - `30`
- targetSdkVersion - `30`
- androidXCore - `1.6.0`
- ndkVersion - `23.0.7599858`
- kotlinVersion - `1.8.0`
- buildToolsVersion - `34.0.0`
- minSdkVersion - `24`
- compileSdkVersion - `34`
- targetSdkVersion - `34`
- ndkVersion - `25.1.8937393`

## Gradle

- Gradle version is set to `7.2`
- com.android.tools.build:gradle - `4.2.2`

- Gradle version is set to `8.3`

## Network security config
There's a network security config which defines next addresses to be allowed:
Expand Down
10 changes: 3 additions & 7 deletions website/docs/internals/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,14 @@ title: iOS internals
## Hermes
Enabled

## Pods
There's a pods post installation action which bumps deployment target version of each pod to `13.0`
(only `RCT-Folly` stays on `11.0` due to to a bug).

## Versions
Deployment target is set to `13.0` later in plans to change it to `14.0`.
Deployment target is set to `13.4`

## Devices
It supports iPhones and iPads
iPhones and iPads are both supported

## Orientations
All unlocked (locked in React Native by device type)
All orientations are unlocked (locked in React Native by device type)

## Flipper
`Flipper` is disabled in `podfile` due to the fact that it increases app size and goes in production as a pod too,
Expand Down

0 comments on commit 7cafb0d

Please sign in to comment.