Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb2281f4

Browse files
committed
docs: updated readme file and other docs
1 parent50a870a commitb2281f4

File tree

8 files changed

+173
-115
lines changed

8 files changed

+173
-115
lines changed

‎.npmignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
sketch
2-
storybook
2+
storybook
3+
templates
4+
_templates

‎CODE_OF_CONDUCT.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
#Code of Conduct
2+
3+
###Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
###Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or
22+
advances of any kind
23+
- Trolling, insulting or derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or email
26+
address, without their explicit permission
27+
- Other conduct which could reasonably be considered inappropriate in a
28+
professional setting
29+
30+
###Enforcement Responsibilities
31+
32+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33+
34+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35+
36+
###Scope
37+
38+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39+
40+
###Enforcement
41+
42+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
43+
44+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45+
46+
###Enforcement Guidelines
47+
48+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49+
50+
####1. Correction
51+
52+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53+
54+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55+
56+
####2. Warning
57+
58+
**Community Impact**: A violation through a single incident or series of actions.
59+
60+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61+
62+
####3. Temporary Ban
63+
64+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65+
66+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67+
68+
####4. Permanent Ban
69+
70+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71+
72+
**Consequence**: A permanent ban from any sort of public interaction within the community.
73+
74+
###Attribution
75+
76+
This Code of Conduct is adapted from the[Contributor Covenant][homepage], version 2.0,
77+
available athttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78+
79+
Community Impact Guidelines were inspired by[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80+
81+
[homepage]:https://www.contributor-covenant.org
82+
83+
For answers to common questions about this code of conduct, see the FAQ at
84+
https://www.contributor-covenant.org/faq. Translations are available athttps://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,33 @@ We want this community to be friendly and respectful to each other. Please follo
77
To get started with the project, run`yarn` in the root directory to install the required dependencies for each package:
88

99
```sh
10-
yarn
10+
yarn bootstrap
1111
```
1212

13-
While developing, you can run the[example app](/example/) to test your changes.
13+
While developing, you can run the[storybook app](/storybook/) to test your changes.
1414

1515
To start the packager:
1616

1717
```sh
18-
yarnexamplestart
18+
yarn start
1919
```
2020

21-
To run theexample app on Android:
21+
To run thestorybook app on Android:
2222

2323
```sh
24-
yarnexampleandroid
24+
yarn android
2525
```
2626

27-
To run theexample app on iOS:
27+
To run thestorybook app on iOS:
2828

2929
```sh
30-
yarn example ios
30+
yarn ios
31+
```
32+
33+
To run the storybook app on web:
34+
35+
```sh
36+
yarn web
3137
```
3238

3339
Make sure your code passes TypeScript and ESLint. Run the following to verify:
@@ -43,16 +49,6 @@ To fix formatting errors, run the following:
4349
yarn lint --fix
4450
```
4551

46-
Remember to add tests for your change if possible. Run the unit tests by:
47-
48-
```sh
49-
yarntest
50-
```
51-
52-
To edit the Objective-C files, open`example/ios/BaseUiExample.xcworkspace` in XCode and find the source files at`Pods > Development Pods > react-native-base-ui`.
53-
54-
To edit the Kotlin files, open`example/android` in Android studio and find the source files at`reactnativebaseui` under`Android`.
55-
5652
###Commit message convention
5753

5854
We follow the[conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
@@ -66,7 +62,7 @@ We follow the [conventional commits specification](https://www.conventionalcommi
6662

6763
Our pre-commit hooks verify that your commit message matches this format when committing.
6864

69-
###Linting and tests
65+
###Linting
7066

7167
[ESLint](https://eslint.org/),[Prettier](https://prettier.io/),[TypeScript](https://www.typescriptlang.org/)
7268

@@ -81,10 +77,11 @@ The `package.json` file contains various scripts for common tasks:
8177
-`yarn bootstrap`: setup project by installing all dependencies and pods.
8278
-`yarn typescript`: type-check files with TypeScript.
8379
-`yarn lint`: lint files with ESLint.
84-
-`yarn test`: run unit tests with Jest.
85-
-`yarn example start`: start the Metro server for the example app.
86-
-`yarn example android`: run the example app on Android.
87-
-`yarn example ios`: run the example app on iOS.
80+
-`yarn start`: start the Metro server for the storybook app.
81+
-`yarn android`: run the storybook app on Android.
82+
-`yarn ios`: run the storybook app on iOS.
83+
-`yarn web`: run the storybook app on web.
84+
-`yarn storybook`: run the storybook server.
8885

8986
###Sending a pull request
9087

@@ -97,88 +94,3 @@ When you're sending a pull request:
9794
- Review the documentation to make sure it looks good.
9895
- Follow the pull request template when opening a pull request.
9996
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
100-
101-
##Code of Conduct
102-
103-
###Our Pledge
104-
105-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
106-
107-
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
108-
109-
###Our Standards
110-
111-
Examples of behavior that contributes to a positive environment for our community include:
112-
113-
- Demonstrating empathy and kindness toward other people
114-
- Being respectful of differing opinions, viewpoints, and experiences
115-
- Giving and gracefully accepting constructive feedback
116-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
117-
- Focusing on what is best not just for us as individuals, but for the overall community
118-
119-
Examples of unacceptable behavior include:
120-
121-
- The use of sexualized language or imagery, and sexual attention or
122-
advances of any kind
123-
- Trolling, insulting or derogatory comments, and personal or political attacks
124-
- Public or private harassment
125-
- Publishing others' private information, such as a physical or email
126-
address, without their explicit permission
127-
- Other conduct which could reasonably be considered inappropriate in a
128-
professional setting
129-
130-
###Enforcement Responsibilities
131-
132-
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
133-
134-
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
135-
136-
###Scope
137-
138-
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
139-
140-
###Enforcement
141-
142-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
143-
144-
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
145-
146-
###Enforcement Guidelines
147-
148-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
149-
150-
####1. Correction
151-
152-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
153-
154-
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
155-
156-
####2. Warning
157-
158-
**Community Impact**: A violation through a single incident or series of actions.
159-
160-
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
161-
162-
####3. Temporary Ban
163-
164-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
165-
166-
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
167-
168-
####4. Permanent Ban
169-
170-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
171-
172-
**Consequence**: A permanent ban from any sort of public interaction within the community.
173-
174-
###Attribution
175-
176-
This Code of Conduct is adapted from the[Contributor Covenant][homepage], version 2.0,
177-
available athttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
178-
179-
Community Impact Guidelines were inspired by[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
180-
181-
[homepage]:https://www.contributor-covenant.org
182-
183-
For answers to common questions about this code of conduct, see the FAQ at
184-
https://www.contributor-covenant.org/faq. Translations are available athttps://www.contributor-covenant.org/translations.

‎README.md‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,59 @@
11
#Base UI
22

3-
>Soon ;)
3+
Base is a design system comprised of modern, responsive, living components. Base UI is the React Native implementation of Base.
4+
5+
[![Base UI](https://img.shields.io/npm/v/gorhom/base-ui?style=flat-square)](https://www.npmjs.com/package/@gorhom/base-ui)[![npm](https://img.shields.io/npm/l/@gorhom/base-ui?style=flat-square)](https://www.npmjs.com/package/@gorhom/base-ui)[![npm](https://img.shields.io/badge/types-included-blue?style=flat-square)](https://www.npmjs.com/package/@gorhom/base-ui)[![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
6+
7+
>This project is a re-written implementation of the**[Base Web](https://github.com/uber/baseweb)**, but for React Native, React Native Web & React Native Desktops (Windows, MacOS, Linux)
8+
9+
![React Native Base UI](./preview.png)
10+
11+
---
12+
13+
##Installation
14+
15+
First you will need to install the library
16+
17+
```bash
18+
yarn add @gorhom/base-ui
19+
```
20+
21+
Then make sure to run`react-native link`, to make sure needed font is installed.
22+
23+
```bash
24+
yarn react-native link
25+
```
26+
27+
##Usage
28+
29+
```tsx
30+
// @TODO
31+
```
32+
33+
##Contributing
34+
35+
This library still in early development stage and will need your help and support to get it to stable stage.
36+
37+
Click here to[read more about contributing](CONTRIBUTING.md).
38+
39+
##Author
40+
41+
-[Mo Gorhom](https://gorhom.dev/)
42+
43+
##License
44+
45+
[MIT](./LICENSE)
46+
47+
<divalign="center">
48+
49+
Liked the library? 😇
50+
51+
<ahref="https://www.buymeacoffee.com/gorhom"target="_blank"><imgsrc="https://cdn.buymeacoffee.com/buttons/default-red.png"alt="Buy Me A Coffee"height="24" ></a>
52+
53+
</div>
54+
55+
---
56+
57+
<palign="center">
58+
<ahref="https://gorhom.dev"target="_blank"><imgheight="34"alt="Mo Gorhom"src="./gorhom.png"></a>
59+
</p>

‎gorhom.png‎

3.83 KB
Loading

‎package.json‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
{
22
"name":"@gorhom/base-ui",
3-
"version":"0.0.0",
4-
"description":"base ui",
3+
"version":"0.0.0-alpha.4",
4+
"description":"A React Native Component library implementing the Base design language.",
55
"main":"lib/commonjs/index",
66
"module":"lib/module/index",
77
"types":"lib/typescript/index.d.ts",
88
"react-native":"src",
99
"source":"src",
1010
"files": [
1111
"src",
12-
"lib"
12+
"lib",
13+
"fonts",
14+
"react-native.config.js"
1315
],
1416
"keywords": [
1517
"react-native",
@@ -34,8 +36,11 @@
3436
"copy-dts":"copyfiles -u 1\"src/**/*.d.ts\" lib/typescript",
3537
"release":"release-it",
3638
"generate:component":"yarn hygen base-ui new",
37-
"bootstrap":"cd ./storybook && yarn",
39+
"bootstrap":"yarn &&cd ./storybook && yarn",
3840
"start":"cd ./storybook && yarn start",
41+
"ios":"cd ./storybook && yarn ios",
42+
"android":"cd ./storybook && yarn android",
43+
"web":"cd ./storybook && yarn web",
3944
"storybook":"cd ./storybook && yarn storybook"
4045
},
4146
"dependencies": {

‎preview.png‎

307 KB
Loading

‎tsconfig.build.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
21
{
32
"extends":"./tsconfig",
4-
"exclude": ["example"]
3+
"exclude": ["storybook"]
54
}

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp