core-native-boilerplate v1.0.6
core-native-boilerplate
This project serves as a simple-to-use boilerplate project to implement the core-native framework to a react-native project.
The core-native framework is a lightweight framework based on React Native + Redux + Redux Saga, in strict TypeScript.
V8 Javascript Engine is used by android by default in this project for better performance.
Quick start
To start, we recommend you to first have latest stable version of nodejs and yarn installed.
To work with ios, you will need to have Xcode and CocoaPods installed.
To work with android, you will need to have Android Studio and the relevant java & android sdks.
Then, simply do git clone https://github.com/RageBill/core-native-boilerplate.git <YOUR_PROJECT_NAME>.
Usage
Install the dependencies with the command
yarn install.Then, install the native dependencies with
yarn native.We have assumed you have both ios and android setup. If you only have either one of them, the above command might not work. You can remove the unwanted part from the above command to suit your needs.
Run either
yarn iosoryarn androidto test out the project.
How to rename project
To rename the project, you can try out react-native-rename.
To do so, you can run:
npx react-native-rename "New App Name Here"
After this, you will have a few other places to rename your app manually, here's the list:
- package.json
- app/bootstrap.ts
- android/app/_BUCKDon't forget you'll have to run yarn native again since renaming the project will modify the Podfile.
You are now good to go!
Development
Module generation
The structure of a module is opinionated in the core-native framework. To create a new module, we have prepared a module generation script to ease the process.
To create a new sub-module, first, make sure you create the necessary module folder. In this example, we have common and main module folders.
Then, after you have the module folder ready, you can then run yarn module {module_name}/{sub_module_name}.
For example, if you want to create account/home, first, you will need to create the account folder under the module folder.
Then, you can run yarn module account/home and then you will have the account/home module as needed.
If you need to create account/create module next, since you already have the account folder, this time you can simply run yarn module account/create.
Format code
You can format your codes with prettier by running yarn format.
Code checking
You can run yarn run check to lint your code, check for code style and compile it with typescript all in one go.
Since react native does not need the compiled output from typescript at this stage, the no-emit flag is set to true at tsconfig.json.
Can we use class components with core-native?
Sure! The core-native framework works well with class components.
The reason we recommend using function components is because of the Fast Refresh feature in React Native.
The document says:
Local state is not preserved for class components (only function components and Hooks preserve state).
Therefore, use class components at your own risk.