@uiw/react-native-template
v5.4.0
Published
React Native template for react-native-uiw.
Downloads
67
Readme
React Native UIW Template
React Native Template for @uiw/react-native.
Migrate from @uiw/react-native-template 0.1.2 to v1.1.0
Features
This template includes the following:
- Elegant usage directly within the React Native CLI
- React Native 0.60 support (now with Hooks! 🙌).
- Easy to use and understand folder structure to get you up and running as fast as possible.
- @uiw/react-native component framework and themes.
- Using react-navigation to routing and navigate your React Native applications.
- Redux support (with @rematch example)
- ESLint, and Prettier configured out-of-the-box
- Using mocker-api that creates mocks for REST APIs.
Installation and Usage
🚧 This template only works with the new CLI. This template is intended for React Native versions >= 0.61
. It has not been tested with previous versions.
Note on the legacy CLI
🚧 There seems to be quite some confusion about the legacy CLI. This template only works with the new CLI. Make sure you have uninstalled the legacy react-native-cli
first (npm uninstall -g react-native-cli
), for the below command to work.
npm uninstall -g react-native-cli
Further information can be found here: https://github.com/react-native-community/cli#about
🚧🚧 If you wish to not use [email protected]
or higher
help
Check whether your ruby version is higher than 2.7.5
bundle install
cd ios && bundle exec pod install
🚧🚧 MacBook Pro with a M1 🚧🚧
# Install ffi
sudo arch -x86_64 gem install ffi
rm -rf Pods Podfile.lock
# Clear pods.
pod deintegrate
# pod rm Podfile.lock
arch -x86_64 pod install
# Re-install pods
arch -x86_64 pod install --repo-update --verbose
yarn run ios # Run instructions for iOS
yarn run api
[email protected]
or higher
npx react-native init MyApp --template @uiw/react-native-template
# npx react-native init MyApp --template @uiw/[email protected]
If you wish to not use npx
you can also install the new CLI globally (npm i -g @react-native-community/cli
or yarn global add @react-native-community/cli
).
npx react-native init MyApp --template @uiw/react-native-template
cd MyApp/ios
# Installing CocoaPods dependencies
pod install
# This will initialize new project using template from TEMPLATE_NAME package
npx react-native init ProjectName --template ${TEMPLATE_NAME}
# This will initialize new project using init command from react-native@VERSION
# but will use TEMPLATE_NAME custom template
npx react-native@${VERSION} init ProjectName --template ${TEMPLATE_NAME}
@uiw/react-native-uiw文档本地预览
yarn run doc
Use husky
Edit package.json > prepare script and run it once:
npm pkg set scripts.prepare="husky install"
npm run prepare
Add a hook:
npx husky add .husky/pre-commit "npm run precommit"
git add .husky/pre-commit
Make a commit:
git commit -m "Keep calm and commit"
# `npm precommit` will run
Dependencies
@react-navigation/native
├──react-native-gesture-handler
├──react-native-reanimated
├──react-native-screens
├──react-native-safe-area-context
└──@react-native-community/masked-view
目录结构
├── Gemfile
├── README.md
├── __tests__
│ └── App-test.js
├── _bundle
│ └── config
├── _node-version
├── android
│ ├── app
│ ├── build.gradle
│ ├── gradle
│ ├── gradle.properties
│ ├── gradlew
│ ├── gradlew.bat
│ └── settings.gradle
├── app.json
├── babel.config.js
├── index.js
├── ios
│ ├── HelloWorld
│ ├── HelloWorld.xcodeproj
│ ├── HelloWorld.xcworkspace
│ ├── HelloWorldTests
│ ├── Podfile
│ ├── Podfile.lock
│ ├── Pods
│ ├── _xcode.env
│ └── build
├── jsconfig.json
├── metro.config.js
├── mocker
│ ├── index.js
│ └── user.mock.js
├── package.json
└── src
├── App.js
├── components
├── config.js
├── global.js
├── hooks
├── models
├── pages
├── routes
├── services
└── utils
Links
Contributors
As always, thanks to our amazing contributors!
Made with contributors.
License
This project is MIT licensed.