Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/react-native-community/upgrade-helper

⚛️ A web tool to support React Native developers in upgrading their apps.
https://github.com/react-native-community/upgrade-helper

react react-native rn-diff rn-diff-purge upgrade-tool

Last synced: 3 months ago
JSON representation

⚛️ A web tool to support React Native developers in upgrading their apps.

Awesome Lists containing this project

README 

        


  




Upgrade Helper





  A web tool to help you upgrade your React Native app with ease! 🚀






  CircleCI

  PRs Welcome






  

    Open the tool!

  




![Image showing a screenshot of Upgrade Helper with the phrase "You are gonna love this!"](https://user-images.githubusercontent.com/6207220/61382138-7a3a6780-a8ac-11e9-8c74-b4cb4830e131.png)



## ⚙️ How to use



[![How to upgrade using upgrade-helper](https://img.youtube.com/vi/fmh_ZGHh_eg/0.jpg)](https://www.youtube.com/watch?v=fmh_ZGHh_eg)



## 🎩 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](https://github.com/react-native-community/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:



- inline comments to help you with more insights about precise files

- a set of links with further explanations on what the version you are upgrading to

- a handy "done" button near each file to help you keep track of your process

- a download button for new binary files

- the ability to toggle all files by holding the alt key and clicking on expand/collapse

- ...and we are planning many more features! Check the [enhancement tag](https://github.com/react-native-community/upgrade-helper/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aenhancement) in the issue section.



## 💻 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

1. Run `yarn install`

1. Run `yarn start`

1. Open `http://localhost:3000`

1. Select starting & target versions

1. 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`](https://github.com/react-native-community/rn-diff-purge), [`react-diff-view`](https://github.com/otakustay/react-diff-view) and [`create-react-app`](https://github.com/facebook/create-react-app).



## 📝 License & CoC



This project is released under the [MIT license](./LICENSE).



Morerover, this projects adopts the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md) and all contributors are expected to follow it.