-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
- Loading branch information
Showing
9 changed files
with
351 additions
and
285 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,69 @@ | ||
# React Native Developer Tools | ||
# `rnx-kit` - React Native tooling by and for developers | ||
|
||
[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&color=007acc&labelColor=444444&logoColor=007acc)](https://vscode.dev/github/microsoft/rnx-kit) | ||
[![Build](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml/badge.svg)](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml) | ||
|
||
### Modern, scalable tools. Exceptional developer experience. | ||
`rnx-kit` is a collection of battle-tested tools created by Microsoft engineers | ||
to optimize the React Native developer experience. It helps filling gaps in the | ||
React Native ecosystem and streamlines the developer workflow. | ||
|
||
You can find guides, documentation, resources, and our blog on the | ||
[project website](https://microsoft.github.io/rnx-kit). | ||
These tools are actively used every day to ship React Native apps at scale | ||
across Microsoft; now they're open source and available for any React Native | ||
project. | ||
|
||
### Made by Developers, for Developers. | ||
## What's included | ||
|
||
_Purpose-built for React Native engineers. Focused on developer experience. | ||
Designed to fit into any project, no matter how large or complex._ | ||
`rnx-kit` includes tools for: | ||
|
||
_Great tools make all the difference._ | ||
- Dependency management - Ensure consistent dependency versions across large | ||
projects with `align-deps`. | ||
- Native builds (experimental) - Build Android and iOS apps in the cloud with | ||
`build`. Avoid installing heavy native toolchains. | ||
- Better bundling - `metro-serializer` allows the enhancement of Metro to add | ||
features such as TypeScript validation with Metro, tree shaking, duplicate and | ||
cyclic dependencies detection. | ||
- Microsoft-tailored defaults - you can find Babel preset for Metro opinionated | ||
for Microsoft usage. | ||
|
||
### Community First | ||
And many more! | ||
|
||
_Created as a GitHub-first repository for the React Native community. Integrated | ||
with tools you already use: Metro, TypeScript, Jest, and more._ | ||
## Get started | ||
|
||
_Join in! Your contributions are always welcome._ | ||
Please follow | ||
[Introduction guide](https://microsoft.github.io/rnx-kit/docs/introduction) on | ||
the documentation website to learn about how you can quickly add the "all in | ||
one" CLI to your project and get most of the tools set out of the box. | ||
|
||
### Tested at scale. Supported by Microsoft. | ||
Or follow the | ||
[Getting started guide](https://microsoft.github.io/rnx-kit/docs/guides/getting-started) | ||
for an easy introduction to our dependency management tool. | ||
|
||
_From unit tests to deployments in large monorepos, each tool is thoroughly | ||
validated. Microsoft has engineers dedicated to this project, using it to ship | ||
React Native apps to millions of customers._ | ||
If you want to use only a specific tool, you can refer to its `README`` for | ||
details; they are all easily readable in the | ||
[Tools section](https://microsoft.github.io/rnx-kit/docs/tools/overview) of the | ||
documentation. | ||
|
||
### Contributing | ||
## Contributing | ||
|
||
Thank you for your interest in this project! We welcome all contributions and | ||
suggestions! | ||
`rnx-kit` is built for the community, by the community - and maintained by | ||
Microsoft engineers. Your contributions are welcome! | ||
|
||
Take a look at | ||
[CONTRIBUTING](https://github.com/microsoft/rnx-kit/tree/main/CONTRIBUTING.md) | ||
for details. | ||
|
||
If you are interested in proposing "substantial" changes, please refer to our | ||
[RFC process](https://github.com/microsoft/rnx-kit/tree/rfcs). | ||
|
||
## License | ||
|
||
[MIT License](LICENSE) | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted the | ||
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the | ||
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any | ||
additional questions or comments. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.