Skip to content

Commit

Permalink
Update documentation (#146)
Browse files Browse the repository at this point in the history
* Update dependency versions in docs

* Update prerequisites versions

* Update overlays and modals
  • Loading branch information
svbutko authored Sep 26, 2023
1 parent 1d3d650 commit ee3bf2c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 32 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@
# [Check out docs to get started](https://svbutko.github.io/react-native-template-strong/)

Build primarily with
- [React Native](https://reactnative.dev) `0.72.4`
- [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.5`
- [Redux Toolkit](https://redux-toolkit.js.org) `1.9.6`
- [TypeScript](https://www.typescriptlang.org) `5.2.2`

Includes next components:
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.4.2`
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.0`
- [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.8.4`
- [Permissions](https://github.com/zoontek/react-native-permissions) `3.9.2`
- [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`
- [Reanimated carousel](https://github.com/dohooo/react-native-reanimated-carousel) `3.5.1`
Expand All @@ -36,22 +36,22 @@ Includes next components:
- [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`
- [Mask input](https://github.com/CaioQuirinoMedeiros/react-native-mask-input) `1.2.3`
- [DayJS](https://github.com/iamkun/dayjs/) `1.11.9`
- [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.2.4`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.4.2`
- [Menu](https://github.com/react-native-menu/menu) `0.8.0`
- [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`
- [Menu](https://github.com/react-native-menu/menu) `0.9.1`

Testing made with:
- [Jest](https://github.com/facebook/jest) `29.6.4`
- [Detox](https://github.com/wix/Detox) `20.11.4`
- [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`

Code quality covered with:
- [ESLint](https://github.com/eslint/eslint) `8.48.0`
- [ESLint](https://github.com/eslint/eslint) `8.50.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.2`
- [Prettier](https://github.com/prettier/prettier) `3.0.3`
- [Lint staged](https://github.com/okonet/lint-staged) `14.0.1`

And many other day-to-day useful dependencies.
24 changes: 12 additions & 12 deletions website/docs/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ 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.4`
- [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.5`
- [Redux Toolkit](https://redux-toolkit.js.org) `1.9.6`
- [TypeScript](https://www.typescriptlang.org) `5.2.2`

Includes next components:
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.4.2`
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.0`
- [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.8.4`
- [Permissions](https://github.com/zoontek/react-native-permissions) `3.9.2`
- [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`
- [Reanimated carousel](https://github.com/dohooo/react-native-reanimated-carousel) `3.5.1`
Expand All @@ -29,22 +29,22 @@ Includes next components:
- [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`
- [Mask input](https://github.com/CaioQuirinoMedeiros/react-native-mask-input) `1.2.3`
- [DayJS](https://github.com/iamkun/dayjs/) `1.11.9`
- [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.2.4`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.4.2`
- [Menu](https://github.com/react-native-menu/menu) `0.8.0`
- [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`
- [Menu](https://github.com/react-native-menu/menu) `0.9.1`

Testing made with:
- [Jest](https://github.com/facebook/jest) `29.6.4`
- [Detox](https://github.com/wix/Detox) `20.11.4`
- [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`

Code quality covered with:
- [ESLint](https://github.com/eslint/eslint) `8.48.0`
- [ESLint](https://github.com/eslint/eslint) `8.50.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.2`
- [Prettier](https://github.com/prettier/prettier) `3.0.3`
- [Lint staged](https://github.com/okonet/lint-staged) `14.0.1`

It also includes other small or utility components.
Expand Down
8 changes: 4 additions & 4 deletions website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ 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 Flamingo | 2022.2.1 Patch 2](https://developer.android.com/studio)
- [Android Studio Giraffe | 2022.3.1 Patch 1](https://developer.android.com/studio)
- Gradle 7.4.2
- JDK 11 (Zulu 11)
- [XCode 14.3.1 (14E300c)](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
- [Node 20.4.0](https://nodejs.org/)
- npm 9.7.2
- [XCode 15.0](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
- [Node 20.7.0](https://nodejs.org/)
- npm 10.1.0

## Usage

Expand Down
8 changes: 4 additions & 4 deletions website/docs/navigation/overlays-and-modals.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Overlays and modals are being added the same way as pages.

There are a couple of pre-made modals and overlays, they are located in `src/navigation/helpers`.

- `showToast` - shows custom-made toast with supplied parameters
- `showStorybook` - shows StoryBook while in debug (you can access it from dev menu by shaking your device)
- `showDatePicker` - shows `DatePicker` with supplied options.
- `showOnboarding` - iOS only way to show onboarding when user first time launches application to show him what's available in app as `overlay`
- `showToast` - shows custom-made toast with supplied parameters.
- `showStorybook` - shows `StoryBook` while in debug (you can access it from dev menu by shaking your device).
- `showModal` - shows `modal` on iOS and `overlay` on Android with supplied options.
- `showOnboarding` - iOS only way to show onboarding when user first time launches application to show him what's available in app as `overlay`.

0 comments on commit ee3bf2c

Please sign in to comment.