Skip to content

Add info on defining cross-platform env variables #8388

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thexpand
Copy link

No description provided.

@facebook-github-bot
Copy link

Hi thexpand! Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@amyrlam amyrlam self-assigned this Jan 30, 2020

```json
{
"start": "HTTPS=true react-scripts start"
}
```

Or you can create a `.env` file with `HTTPS=true` set.
However, this will only work on Linux and macOS (Bash), as Windows defines the environment variables differently. You can use [`cross-env`](https://www.npmjs.com/package/cross-env) to overcome this issue. The package provides a seamless way of defining cross-platform environment variables through the CLI. After installing `cross-env` through your favourite package manager, you can use it to include the environment variable in the `npm start` script like so:
Copy link
Contributor

Choose a reason for hiding this comment

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

@thexpand thanks for the PR! How about keeping ### Linux, macOS (Bash) as-is, and adding a separate header ### Linux, Windows so that it's more clear at a glance?

cc @oluoluoxenfree

Copy link
Author

Choose a reason for hiding this comment

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

@amyrlam Yes, it makes sense. I'll separate it. Maybe the section can be named even better, like this: ### Cross-platform (Linux, Windows, macOS) - what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

@thexpand 👍 sounds good, thank you!

@amyrlam amyrlam removed their assignment Jul 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants