search

ooni / explorer

OONI Explorer: uncover evidence of internet censorship worldwide
https://explorer.ooni.org
BSD 3-Clause "New" or "Revised" License
71 stars 37 forks source link

Updating ReadMe to support Windows user #747

Closed harisankar01 closed 2 years ago

harisankar01 commented 2 years ago

As per https://github.com/ooni/explorer/issues/739, I have added details required for windows developers to run the yarn dev on local environment without errors by changing scripts path in package.json and also added extra documentation to support new users (#745). closes #739 closes #745

vercel[bot] commented 2 years ago

@harisankar01 is attempting to deploy a commit to the OONI Team on Vercel.

A member of the Team first needs to authorize it.

sarathms commented 2 years ago

Hi @harisankar01. Thanks for thinking about how to support development on Windows. However, the change you proposed here needs to be discussed further. There might be more scenarios, but consider the situation when we make changes the scripts section in package.json. Now we have to remember to make parallel changes in this section of Readme.md which is very likely to be missed and then they are out of sync.

It might create confusion when these changes are accidentally committed by someone as part of other code changes.

As an alternative, can you use separate entries in scripts to be used in windows? e.g

   "build:win": "a different command for windows",
   "test:win": "...",
harisankar01 commented 2 years ago

Okay. Let me work on it.

harisankar01 commented 2 years ago

Made the changes as per the instructions. Also has issue #746 . Thank you