-
Notifications
You must be signed in to change notification settings - Fork 96
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
feat: update environment variables to use javascript-based config #249
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5b15cef
feat: add env.config.js to gitignore
jsnwesson f041d35
docs: add example env.config.js file
jsnwesson d22dc31
Merge branch 'master' into jwesson/update-to-jsbased-config
jsnwesson ec4e9e8
docs: add comments around how to set up env.config.js and testing wit…
jsnwesson e191448
docs: add more context in using env.config.js
jsnwesson edc4afe
fix: typo in setUp context
jsnwesson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
.DS_Store | ||
.eslintcache | ||
env.config.js | ||
node_modules | ||
npm-debug.log | ||
coverage | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
/* | ||
Learner Dashboard is now able to handle JS-based configuration! | ||
|
||
For the time being, the `.env.*` files are still made available when cloning down this repo or pulling from | ||
the master branch. To switch to using `env.config.js`, make a copy of `example.env.config.js` and configure as needed. | ||
|
||
For testing with Jest Snapshot, there is a mock in `/src/setupTest.jsx` for `getConfig` that will need to be | ||
uncommented. | ||
|
||
Note: having both .env and env.config.js files will follow a predictable order, in which non-empty values in the | ||
JS-based config will overwrite the .env environment variables. | ||
|
||
frontend-platform's getConfig loads configuration in the following sequence: | ||
- .env file config | ||
- optional handlers (commonly used to merge MFE-specific config in via additional process.env variables) | ||
- env.config.js file config | ||
- runtime config | ||
*/ | ||
|
||
module.exports = { | ||
NODE_ENV: 'development', | ||
NODE_PATH: './src', | ||
PORT: 1996, | ||
BASE_URL: 'localhost:1996', | ||
LMS_BASE_URL: 'http://localhost:18000', | ||
ECOMMERCE_BASE_URL: 'http://localhost:18130', | ||
LOGIN_URL: 'http://localhost:18000/login', | ||
LOGOUT_URL: 'http://localhost:18000/logout', | ||
LOGO_URL: 'https://edx-cdn.org/v3/default/logo.svg', | ||
LOGO_TRADEMARK_URL: 'https://edx-cdn.org/v3/default/logo-trademark.svg', | ||
LOGO_WHITE_URL: 'https://edx-cdn.org/v3/default/logo-white.svg', | ||
LOGO_POWERED_BY_OPEN_EDX_URL_SVG: 'https://edx-cdn.org/v3/stage/open-edx-tag.svg', | ||
FAVICON_URL: 'https://edx-cdn.org/v3/default/favicon.ico', | ||
CSRF_TOKEN_API_PATH: '/csrf/api/v1/token', | ||
REFRESH_ACCESS_TOKEN_ENDPOINT: 'http://localhost:18000/login_refresh', | ||
ACCESS_TOKEN_COOKIE_NAME: 'edx-jwt-cookie-header-payload', | ||
USER_INFO_COOKIE_NAME: 'edx-user-info', | ||
SITE_NAME: 'localhost', | ||
DATA_API_BASE_URL: 'http://localhost:8000', | ||
// LMS_CLIENT_ID should match the lms DOT client application in your LMS container | ||
LMS_CLIENT_ID: 'login-service-client-id', | ||
SEGMENT_KEY: '', | ||
FEATURE_FLAGS: {}, | ||
MARKETING_SITE_BASE_URL: 'http://localhost:18000', | ||
SUPPORT_URL: 'http://localhost:18000/support', | ||
CONTACT_URL: 'http://localhost:18000/contact', | ||
OPEN_SOURCE_URL: 'http://localhost:18000/openedx', | ||
TERMS_OF_SERVICE_URL: 'http://localhost:18000/terms-of-service', | ||
PRIVACY_POLICY_URL: 'http://localhost:18000/privacy-policy', | ||
FACEBOOK_URL: 'https://www.facebook.com', | ||
TWITTER_URL: 'https://twitter.com', | ||
YOU_TUBE_URL: 'https://www.youtube.com', | ||
LINKED_IN_URL: 'https://www.linkedin.com', | ||
REDDIT_URL: 'https://www.reddit.com', | ||
APPLE_APP_STORE_URL: 'https://www.apple.com/ios/app-store/', | ||
GOOGLE_PLAY_URL: 'https://play.google.com/store', | ||
ENTERPRISE_MARKETING_URL: 'http://example.com', | ||
ENTERPRISE_MARKETING_UTM_SOURCE: 'example.com', | ||
ENTERPRISE_MARKETING_UTM_CAMPAIGN: 'example.com Referral', | ||
ENTERPRISE_MARKETING_FOOTER_UTM_MEDIUM: 'Footer', | ||
LEARNING_BASE_URL: 'http://localhost:2000', | ||
SESSION_COOKIE_DOMAIN: 'localhost', | ||
ZENDESK_KEY: '', | ||
HOTJAR_APP_ID: '', | ||
HOTJAR_VERSION: 6, | ||
HOTJAR_DEBUG: '', | ||
NEW_RELIC_APP_ID: '', | ||
NEW_RELIC_LICENSE_KEY: '', | ||
ACCOUNT_SETTINGS_URL: 'http://localhost:1997', | ||
ACCOUNT_PROFILE_URL: 'http://localhost:1995', | ||
ENABLE_NOTICES: '', | ||
CAREER_LINK_URL: '', | ||
OPTIMIZELY_FULL_STACK_SDK_KEY: '', | ||
EXPERIMENT_08_23_VAN_PAINTED_DOOR: true, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌 Thank you for adding this valuable context