react-native-web README

The project's README from github.com/necolas/react-native-web. As one markdown file: README.md.

Development monorepo

This is the development monorepo for "React Native for Web" and related projects.

Structure

Tasks

More details can be found in the contributing guide below.

Contributing

Development happens in the open on GitHub and we are grateful for contributions including bugfixes, improvements, and ideas.

Code of conduct

This project expects all participants to adhere to Meta's OSS Code of Conduct. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing guide

Read the contributing guide to learn about the development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native for Web.

Good first issues

To help you get you familiar with the contribution process, there is a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

react-native-web (necolas/react-native-web)

Searching Database…

What is this?React Native for Web is a set of cross-platform React UI packages; this repository is the development monorepo where the react-native-web package and related projects are built.
Is this something I install into my app, or a full application on its own?It is a library, not an app: react-native-web ships as React UI packages you use as a dependency, and this repo is the dev monorepo holding those packages together with their build, lint and test tooling.
How do I get the project running locally?Clone the repo and use the npm scripts: npm run build compiles every package (npm run build -w targets a single one), npm run dev runs dev builds, and npm run test executes the test suite.
What do I need installed to build and work on it?A standard Node.js and npm environment — the packages are managed as npm workspaces — plus Flow for type checking, ESLint for linting and Prettier for formatting.
Does this repo show me how to use the components in my own app?No — it documents development rather than usage: the README covers repo structure, build, tests and the contribution workflow, while the contributing guide describes the development process; there is no app-level install or API guide here.
Where do the components actually run — just the browser, or native mobile too?They render in the browser via react-dom — the main package is react-native-web — and the project bills itself as cross-platform React UI, so the components are shared across web and React Native.
What does the monorepo actually contain?Four folders: .github with GitHub Actions workflows and issue templates, configs with the shared tooling configuration, packages holding react-native-web and the other packages, and scripts with Node.js helper scripts for miscellaneous tasks.
How does the project catch React-related breakage?Continuous integration runs a react-integration workflow alongside tests, labels and performance checks, so changes are validated against real React integration scenarios, not just the unit test suite.
Creator
necolas
Size
94 MB
Stars
22.2K
Age
11y
Commits · 90 Days