|
4 | 4 | [![react-native-builder-bob][react-native-builder-bob-version-badge]][react-native-builder-bob]
|
5 | 5 | [![MIT License][license-badge]][license]
|
6 | 6 |
|
7 |
| -👷♂️ Simple set of CLIs to scaffold and build React Native libraries for different targets. |
| 7 | +👷♂️ Set of CLIs to scaffold and build React Native libraries for different targets. |
8 | 8 |
|
9 | 9 | ## Scaffold React Native libraries
|
10 | 10 |
|
11 | 11 | If you want to create your own React Native module, scaffolding the project can be a daunting task. `create-react-native-library` can scaffold a new project for you with the following things:
|
12 | 12 |
|
13 |
| -- Simple example modules for Android and iOS which you can build upon |
14 |
| -- [Kotlin](https://kotlinlang.org/) configured for building the module on Android |
15 |
| -- C++ support for native modules on Android and iOS |
16 |
| -- [Expo](https://expo.io/) support for libraries without native code and web support |
17 |
| -- Example React Native app to manually test your modules |
| 13 | +- Minimal boilerplate modules on which you can build upon |
| 14 | +- Example React Native app to test your modules |
| 15 | +- [TypeScript](https://www.typescriptlang.org/) to write |
| 16 | +- Support for [Turbo Modules](https://reactnative.dev/docs/next/the-new-architecture/pillars-turbomodules) & [Fabric](https://reactnative.dev/docs/next/the-new-architecture/pillars-fabric-components) |
| 17 | +- Support for [Kotlin](https://kotlinlang.org/) on Android & [Swift](https://developer.apple.com/swift/) on iOS |
| 18 | +- Support for C++ to write cross-platform native code |
| 19 | +- [Expo](https://expo.io/) for libraries without native code and web support |
18 | 20 | - [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/), [Lefthook](https://github.com/evilmartians/lefthook) and [Release It](https://github.com/release-it/release-it) pre-configured
|
19 | 21 | - `react-native-builder-bob` pre-configured to compile your files
|
20 |
| -- [CircleCI](https://circleci.com/) pre-configured to run tests on the CI |
| 22 | +- [GitHub Actions](https://github.com/features/actions) pre-configured to run tests and lint on the CI |
21 | 23 |
|
22 | 24 | To create new project, run the following:
|
23 | 25 |
|
24 | 26 | ```sh
|
25 |
| -npx create-react-native-library@latest react-native-awesome-library |
| 27 | +npx create-react-native-library@latest awesome-library |
26 | 28 | ```
|
27 | 29 |
|
28 |
| -This will ask you few questions about your project and generate a new project in a folder named `react-native-awesome-library`. |
| 30 | +This will ask you few questions about your project and generate a new project in a folder named `awesome-library`. |
29 | 31 |
|
30 | 32 | <img src="assets/create-react-native-library.gif" width="500px" height="auto">
|
31 | 33 |
|
|
0 commit comments