Files
react-native-web/README.md
Bartosz Kaszubowski 618660484f Update Expo info in docs
Close #2460
2023-03-20 12:25:50 -07:00

50 lines
2.1 KiB
Markdown

# Development monorepo
This is the development monorepo for "React Native for Web" and related projects.
## Structure
* `.github`
* Contains workflows used by GitHub Actions.
* Contains issue templates.
* `configs`
* Contains configuration 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.
## Tasks
* `build`
* Use `npm run build` to run the build script in every package.
* Use `npm run build -w <package-name>` to run the build script for a specific package.
* `dev`
* Use `npm run dev` to run the dev script in every package.
* Use `npm run dev -w <package-name>` to run the dev script for a specific package.
* `test`
* Use `npm run test` to run tests for every package.
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][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][contributing-url] 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][good-first-issue-url] that contain bugs which have a relatively limited scope. This is a great place to get started.
[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/