zoriya/react-native-web
1
0
Fork 0
mirror of https://github.com/zoriya/react-native-web.git synced 2026-05-25 15:42:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reorganize README and LICENSE files

Browse Source
This commit is contained in:
Nicolas Gallagher
2022-07-01 13:47:59 -07:00
parent b704844ca7
commit aee652f6c9
12 changed files with 189 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -49
View File
@@ -1,51 +1,25 @@
# React Native for Web
# Development monorepo
[![npm version][package-badge]][package-url] [![Build Status][ci-badge]][ci-url] [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
## Structure
"React Native for Web" makes it possible to run [React Native][react-native-url] components and APIs on the web using React DOM.
## Documentation
The [documentation site](https://necolas.github.io/react-native-web/) covers installation, guides, and APIs.
## Example
And here is a simple example to get you started. The [example app](https://pk4zn6v4o0.sse.codesandbox.io/) (fork the [codesandbox](https://codesandbox.io/s/github/necolas/react-native-web/tree/master/packages/react-native-web-examples)) includes interactive examples and the [source code](https://github.com/necolas/react-native-web/blob/master/packages/react-native-web-examples) is also available.
```js
import React from 'react';
import { AppRegistry, StyleSheet, Text, View } from 'react-native';
class App extends React.Component {
render() {
return (
<View style={styles.box}>
<Text style={styles.text}>Hello, world!</Text>
</View>
);
}
}
const styles = StyleSheet.create({
box: { padding: 10 },
text: { fontWeight: 'bold' }
});
AppRegistry.registerComponent('App', () => App);
AppRegistry.runApplication('App', { rootTag: document.getElementById('react-root') });
```
This example will render the `App` into a container on the page.
You'll notice that there is no reference to `react-dom`; the `App` component is defined using the platform-agnostic APIs and Components introduced by React Native. This allows the app to be rendered to web and native platforms.
* `.github`
* Contains workflows used by GitHub Actions.
* Contains issue templates.
* `configs`
* Contains configration files used by the monorepo tooling (compiling, linting, testing, etc.)
* `packages`
* [react-native-web](https://github.com/necolas/react-native-web/blob/master/packages/react-native-web)
* Contains the individual packages managed in the monorepo.
* `scripts`
* Contains Node.js scripts for miscellaneous tasks.
## Contributing
The main purpose of this repository is to help evolve React web and native development towards the platform-agnostic design of React Native, and in the process make it faster and easier to build high-quality experiences for the web with React. Development happens in the open on GitHub, and we are grateful for contributing bugfixes and improvements. Read below to learn how you can take part in improving React Native for Web.
Development happens in the open on GitHub and we are grateful for contributions including bugfixes, improvements, and ideas.
### Code of conduct
Meta has adopted a [Code of Conduct][code-of-conduct] that this project expects all participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
This project expects all participants to adhere to Meta's OSS [Code of Conduct][code-of-conduct]. Please read the full text so that you can understand what actions will and will not be tolerated.
### Contributing guide
@@ -55,15 +29,6 @@ Read the [contributing guide][contributing-url] to learn about the development p
To help you get you familiar with the contribution process, there is a list of [good first issues][good-first-issue-url] that contain bugs which have a relatively limited scope. This is a great place to get started.
## License
React Native for Web is [MIT licensed](./LICENSE). By contributing to React Native for Web, you agree that your contributions will be licensed under its MIT license.
[package-badge]: https://img.shields.io/npm/v/react-native-web.svg?style=flat
[package-url]: https://www.npmjs.com/package/react-native-web
[ci-badge]: https://github.com/necolas/react-native-web/workflows/tests/badge.svg
[ci-url]: https://github.com/necolas/react-native-web/actions
[react-native-url]: https://reactnative.dev/
[contributing-url]: https://github.com/necolas/react-native-web/blob/master/.github/CONTRIBUTING.md
[good-first-issue-url]: https://github.com/necolas/react-native-web/labels/good%20first%20issue
[code-of-conduct]: https://opensource.fb.com/code-of-conduct/