Home

Awesome

<p align="center"> <img src="/src/assets/logo.svg" width="150" /> </p> <h1 align="center">Upgrade Helper</h1> <p align="center"> A web tool to help you upgrade your React Native app with ease! 🚀 </p> <p align="center"> <a href="https://circleci.com/gh/react-native-community/upgrade-helper"><img src="https://circleci.com/gh/react-native-community/upgrade-helper.svg?style=shield" alt="CircleCI" title="CircleCI"></a> <a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shield" alt="PRs Welcome" title="PRs Welcome"></a> </p> <p align="center"> <a href="https://react-native-community.github.io/upgrade-helper"> Open the tool! </a> </p>

Image showing a screenshot of Upgrade Helper with the phrase "You are gonna love this!"

⚙️ How to use

How to upgrade using upgrade-helper

🎩 How it works

The Upgrade Helper tool aims to provide the full set of changes happening between any two versions, based on the previous work done in the rn-diff-purge project:

This repository exposes an untouched React Native app generated with the CLI react-native init RnDiffApp. Each new React Native release causes a new project to be created, removing the old one, and getting a diff between them. This way, the diff is always clean, always in sync with the changes of the init template.

This will help you see what changes you need to do in your code.

Aside from this, the tool provides you a couple of cool extra features:

💻 Contributing

If you want to help us making this better, you can start by forking the project and follow these steps to testing it out locally:

  1. Clone the project
  2. Run yarn install
  3. Run yarn start
  4. Open http://localhost:3000
  5. Select starting & target versions
  6. Click the Show me how to upgrade button

After which, you can create a branch to to make your changes and then open a PR against this repository following the provided template 🤗

📣 Acknowledgments

This project proudly uses rn-diff-purge, react-diff-view and create-react-app.

📝 License & CoC

This project is released under the MIT license.

Morerover, this projects adopts the Contributor Covenant Code of Conduct and all contributors are expected to follow it.