https://github.com/coursedesign/rn-system
common element for react native
https://github.com/coursedesign/rn-system
Last synced: 10 months ago
JSON representation
common element for react native
- Host: GitHub
- URL: https://github.com/coursedesign/rn-system
- Owner: CourseDesign
- License: mit
- Created: 2021-07-17T17:29:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-07T07:22:25.000Z (over 4 years ago)
- Last Synced: 2025-02-10T08:51:30.005Z (11 months ago)
- Language: TypeScript
- Size: 1.43 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @course-design/rn-system
common element for react native
## Getting started
### Requirements
* `react-native-reanimated` >= 2.0.0
* `react-native-gesture-handler` >= 1.10.0
### Pre-installation
You **MUST** to follow below instructions before install `@course-design/rn-system`
* [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated): [instruction](https://docs.swmansion.com/react-native-reanimated/docs/installation)
* [react-native-gesture-handler](https://github.com/software-mansion/react-native-gesture-handler): [instruction](https://docs.swmansion.com/react-native-gesture-handler/docs/)
### Installation
```shell
npm install --save @course-design/rn-system
```
or if you want to use yarn
```shell
yarn add @course-design/rn-system
```
## Example
You want to try this library without setting RN project, you can run `example` project
1. Clone this repository
2. Install dependencies
```shell
npm run bootstrap
```
3. Run example
```shell
npm run android
```
or
```shell
npm run ios
```
## Documentation
* [Typedoc](https://coursedesign.github.io/rn-system)
* [Notion](https://www.notion.so/coursedesign/course-design-rn-system-b493624ce978497ea0f449e91526fc33)
## License
MIT