Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating ReadMe to support Windows user #747

Closed
wants to merge 11 commits into from
Closed

Updating ReadMe to support Windows user #747

wants to merge 11 commits into from

Conversation

harisankar01
Copy link
Contributor

@harisankar01 harisankar01 commented Apr 17, 2022

As per #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
Copy link

vercel bot commented Apr 17, 2022

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

A member of the Team first needs to authorize it.

@sarathms
Copy link
Contributor

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
Copy link
Contributor Author

Okay. Let me work on it.

@harisankar01
Copy link
Contributor Author

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

"export": ". ./scripts/populate-git-env.sh && next export",
"export:win": "./scripts/populate-git-env.sh && next export",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two commands are not really equivalent to each other, since you aren't running the shell script with with . (or source), the exported environment variables aren't actually being included in the context of next *.

I think we either find a way to make the definition of these env vars work on windows, or we just drop the running of those scripts on windows so that we don't mislead a developer into believing they are actually doing something.

pages/search.js Outdated
@@ -338,7 +340,7 @@ class Search extends React.Component {
// When `hideFailure` is true, add `failure=false` in the query
query[queryParam] = false
} else {
delete query[queryParam]
query[queryParam] = true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change came from a different branch and should be included a separate PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay let me change it.

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve README.md yarn run dev doesn't work on windows
3 participants