Skip to content

Commit

Permalink
Update documentation (#166)
Browse files Browse the repository at this point in the history
* Update website dependencies

* Update README versions

* Update dependencies docs

* Change author link

* Update website dependencies

* Update versions

* Minor markdown changes

* Update getting started

* Update store page

* Update storybook

* Update Android docs

* Update iOS docs
  • Loading branch information
svbutko authored May 5, 2024
1 parent 3752c02 commit c1080c4
Show file tree
Hide file tree
Showing 10 changed files with 2,550 additions and 2,190 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<h1 align="center">
<h1>
<img src="./website/static/img/strong.png" alt="strong"/>
<br/>
React Native Template Strong
<br/>
</h1>

<p align="center">
<p>
Quick, opinionated, documented and strong beginning for your next project.
</p>

Expand All @@ -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.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`
- [React Native](https://reactnative.dev) `0.74.1`
- [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) `7.39.2`
- [Redux Toolkit](https://redux-toolkit.js.org) `2.2.3`
- [TypeScript](https://www.typescriptlang.org) `5.4.5`

Includes next components:
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.2`
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `8.0.0`
- [Localization](https://github.com/stefalda/ReactNativeLocalization) `2.3.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`
- [Orientation locker](https://github.com/wonday/react-native-orientation-locker) `1.7.0`
- [Permissions](https://github.com/zoontek/react-native-permissions) `4.1.5`
- [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.2`
- [Image crop picker](https://github.com/ivpusic/react-native-image-crop-picker) `0.41.0`
- [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.3`
- [Vector icons](https://github.com/oblador/react-native-vector-icons) `10.1.0`
- [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.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) `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`
- [DayJS](https://github.com/iamkun/dayjs/) `1.11.11`
- [Net info](https://github.com/react-native-netinfo/react-native-netinfo) `11.3.1`
- [Share](https://github.com/react-native-share/react-native-share) `10.2.0`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.10.0`
- [Menu](https://github.com/react-native-menu/menu) `1.0.2`

Testing made with:
- [Jest](https://github.com/facebook/jest) `29.7.0`
- [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`
- [Detox](https://github.com/wix/Detox) `20.20.3`
- [Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react-native/en/get-started/) `7.6.18`

Code quality covered with:
- [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.1.1`
- [Lint staged](https://github.com/okonet/lint-staged) `15.2.0`
- [ESLint](https://github.com/eslint/eslint) `8.57.0`
- [ESLint Config React Strong](https://github.com/svbutko/eslint-config-react-strong) `2.4.0`
- [Husky](https://github.com/typicode/husky) `9.0.11`
- [Prettier](https://github.com/prettier/prettier) `3.2.5`
- [Lint staged](https://github.com/okonet/lint-staged) `15.2.2`

And many other day-to-day useful dependencies.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"reanimatedv3",
"starter-kit"
],
"author": "Sergei Butko (https://twitter.com/@svbutko)",
"author": "Sergei Butko (https://github.com/svbutko)",
"license": "MIT",
"bugs": {
"url": "https://github.com/svbutko/react-native-template-strong/issues"
Expand All @@ -35,7 +35,7 @@
"contributors": [
{
"name": "Sergei Butko",
"url": "https://twitter.com/@svbutko"
"url": "https://github.com/svbutko"
}
]
}
44 changes: 22 additions & 22 deletions website/docs/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,43 +11,43 @@ 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.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`
- [React Native](https://reactnative.dev) `0.74.1`
- [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) `7.39.2`
- [Redux Toolkit](https://redux-toolkit.js.org) `2.2.3`
- [TypeScript](https://www.typescriptlang.org) `5.4.5`

Includes next components:
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `7.6.2`
- [Date time picker](https://github.com/react-native-datetimepicker/datetimepicker) `8.0.0`
- [Localization](https://github.com/stefalda/ReactNativeLocalization) `2.3.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`
- [Orientation locker](https://github.com/wonday/react-native-orientation-locker) `1.7.0`
- [Permissions](https://github.com/zoontek/react-native-permissions) `4.1.5`
- [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.2`
- [Image crop picker](https://github.com/ivpusic/react-native-image-crop-picker) `0.41.0`
- [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.3`
- [Vector icons](https://github.com/oblador/react-native-vector-icons) `10.1.0`
- [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.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) `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`
- [DayJS](https://github.com/iamkun/dayjs/) `1.11.11`
- [Net info](https://github.com/react-native-netinfo/react-native-netinfo) `11.3.1`
- [Share](https://github.com/react-native-share/react-native-share) `10.2.0`
- [Reanimated](https://github.com/software-mansion/react-native-reanimated) `3.10.0`
- [Menu](https://github.com/react-native-menu/menu) `1.0.2`

Testing made with:
- [Jest](https://github.com/facebook/jest) `29.7.0`
- [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`
- [Detox](https://github.com/wix/Detox) `20.20.3`
- [Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react-native/en/get-started/) `7.6.18`

Code quality covered with:
- [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.1.1`
- [Lint staged](https://github.com/okonet/lint-staged) `15.2.0`
- [ESLint](https://github.com/eslint/eslint) `8.57.0`
- [ESLint Config React Strong](https://github.com/svbutko/eslint-config-react-strong) `2.4.0`
- [Husky](https://github.com/typicode/husky) `9.0.11`
- [Prettier](https://github.com/prettier/prettier) `3.2.5`
- [Lint staged](https://github.com/okonet/lint-staged) `15.2.2`

It also includes other small or utility components.
And many other day-to-day useful dependencies.

## Scripts

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 Hedgehog | 2023.1.1 Patch 1](https://developer.android.com/studio)
- Gradle 8.3
- [Android Studio Jellyfish | 2023.3.1](https://developer.android.com/studio)
- Gradle 8.6
- 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
- [Node 21.6.1](https://nodejs.org/)
- npm 10.2.4

## Usage

Expand Down
6 changes: 3 additions & 3 deletions website/docs/internals/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ By default `proguard` is disabled
## Versions

Next versions are being used:
- kotlinVersion - `1.8.0`
- kotlinVersion - `1.9.22`
- buildToolsVersion - `34.0.0`
- minSdkVersion - `24`
- compileSdkVersion - `34`
- targetSdkVersion - `34`
- ndkVersion - `25.1.8937393`
- ndkVersion - `26.1.10909125`

## Gradle

- Gradle version is set to `8.3`
- Gradle version is set to `8.6`

## Network security config
There's a network security config which defines next addresses to be allowed:
Expand Down
5 changes: 0 additions & 5 deletions website/docs/internals/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,3 @@ iPhones and iPads are both supported

## Orientations
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,
you can enable it while testing but don't forget to comment it back.

4 changes: 2 additions & 2 deletions website/docs/redux/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ It's defined in `src/core/store.ts` near the store:
```typescript
const persistConfig: PersistConfig<RootState> = {
key: 'root',
storage: AsyncStorage,
storage: reduxStorage,
version: 1,
timeout: 1000,
};
```

It uses `AsyncStorage` as storage, if you don't like it you can change it to your own likings.
It uses `react-native-mmkv` as storage, if you don't like it you can change it to your own likings.

It creates `persistor`:

Expand Down
30 changes: 6 additions & 24 deletions website/docs/testing/storybook.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,32 +27,14 @@ If you'd like to create a separate stories, then create a file in the `storybook
Create a stories' module (as example I will use `Components`:

```typescript jsx
const ComponentsStories = storiesOf("Components", module);
```

Add your stories into it:

```typescript jsx
ComponentsStories.add("PrimaryButton", () => <PrimaryButtonStories />);
import {Meta} from '@storybook/react';

ComponentsStories.add("PrimaryTextInput", () => <PrimaryTextInputStories />);
const meta = {
component: ComponentStories,
title: 'My own component sotry',
} satisfies Meta<typeof ComponentStories>;

ComponentsStories.add("RadioButton", () => <RadioButtonStories />);
```

And don't forget to require it in `storybook/stories.ts`:

```typescript jsx
if (__DEV__) {
require("./stories/Theme.stories");
require("./stories/Formatter.stories");
require("./stories/Resources.stories");
require("./stories/Components.stories");
require("./stories/ModalsOverlays.stories");
require("./stories/Alerts.stories");
}

export {};
export default meta;
```

## Plugins
Expand Down
Loading

0 comments on commit c1080c4

Please sign in to comment.