Terra Core
- Packages
- Supported Browsers
- Internationalization (I18n)
- Contributing
- Local Development
- Local Development using Docker (Dev Containers)
- LICENSE
Packages
Versioning
When a component reaches v1.0.0., it is considered to be stable and will follow SemVer for versioning.
- MAJOR versions represent breaking changes
- MINOR versions represent added functionality in a backwards-compatible manner
- PATCH versions represent backwards-compatible bug fixes
Consult the component CHANGELOGs, related issues, and PRs for more information.
We view the React.js props API of our components as our main public API. We use this to guide us when versioning components.
Prior to components reaching v1.0.0, a component is considered to be in a beta stage. Components in beta stage may include breaking changes, new features, and bug fixes all within v0.x.x releases.
Status
Deprecated
| Terra Package | Version | Status | Dependencies |
|---|---|---|---|
| terra-form | |||
| terra-i18n-plugin | |||
| terra-legacy-theme | |||
| terra-modal |
Supported Browsers
| Browser | Version |
|---|---|
| Chrome & Chrome for Android | Current |
| Edge | Current |
| Firefox | Current |
| Internet Explorer | 10 & 11 |
| Safari & Mobile Safari | Current |
Internationalization (I18n)
Please review Terra's Internationalization documentation for more information. Included are directions on consumption and how internationalization is setup.
Packages Requiring I18n
- terra-action-header
- terra-alert
- terra-demographics-banner
- terra-dialog
- terra-form-checkbox
- terra-form-field
- terra-form-radio
- terra-form-select
- terra-i18n
- terra-overlay
- terra-search-field
- terra-show-hide
- terra-status-view
Contributing
Please read through our contributing guidelines. Included are directions for issue reporting and pull requests.
Local Development
- Install Node Version Manager (NVM) and Node. The root directory contains a
.nvmrcfile that specifies terra-core's node version. Once NVM is installed and you are within the root directory, your version of node will change to this version. - Install docker https://www.docker.com/ to run browser tests.
- Install dependencies and run tests.
npm install
npm run testLocal Development using Docker (Dev Containers)
- Install Rancher or Docker.
- Rancher is free and open-source and is highly recommended whereas Docker may require a license for use.
- Install Microsoft VS Code.
- Install the Dev Container extension.
- Navigate to View -> Extension -> Search for and install Dev Containers (or "ms-vscode-remote.remote-containers")
- More information on Dev Containers
- Build the dev container:
- (Option 1) - Opening local workspace in dev container
- Clone the repository (or fork) locally and open the project in Visual Studio Code
- Navigate to View -> Command Palette and run Dev Containers: Open Workspace in Container
- (Option 2) - Recommended for Windows for hot-reloading to work during development and improved performance: Creating the dev container using dev volumes (for more information and guidance, see the Official Guide)
- If you have git setup and have global config file ~/.gitconfig locally, these settings should automatically be transferred to the dev container
- Navigate to View -> Command Palette and run Dev Containers: Clone Repository in Container Volume
- Paste the GitHub URL of this repository (or fork)
- VS Code will now reload the workspace and create/start the dev container and volume
- Please note: changes made using this option will only update files in the Docker volume. It is recommended to commit changes often in case the volume is deleted or dev container gets removed.
- (Option 1) - Opening local workspace in dev container
- You're now running in a dev container. Use the terminal of the dev container in Visual Studio Code to issue any npm or bash commands.
- Before running any WDIO tests, make sure to perform the following steps:
- Open a new terminal (outside the dev container) and navigate to ".devcontainer/" path in your repository.
- Execute the command
"docker compose -f docker-compose-wdio.yml up". Selenium hub should spin up. Leave this running in the background. If you see errors saying "container name already exists", run"docker container prune"command followed by pressing "y" to clear up any unused containers and try running the previous command again. - You can now run
npm run test:dockerornpm run wdio:dockercommands to run WDIO tests from inside the Dev Container. - NOTE: Optionally, if you want to run other WDIO commands in the dev container, you can also edit the root package.json file WDIO scripts to include
--disableSeleniumService=trueflag. This will disable the selenium service from spinning up again. For example:"scripts": { "wdio-lowlight": "terra wdio --disableSeleniumService=true --themes clinical-lowlight-theme" }
- To terminate a dev container:
- Use command line or Rancher/Docker Desktop OR
- Using Visual Studio Code
- Select the Remote Explorer icon in the Activity Bar or View -> Command Palette and run Remote Explorer: Focus on Containers View
- Locate the terra-core_devcontainer or currently running dev container under "Dev Containers"
- Right click and select Stop Container and close the workspace
- You can also select Rebuild Container to restart the dev container
- To reopen a dev container:
- Existing local workspace (for Option 1)
- Open the project in Visual Studio Code
- Ensure the workspace contains the .devcontainer folder
- Navigate to View -> Command Palette and run Dev Containers: Open Workspace in Container
- Isolated dev container volume (for Option 2)
- Open Visual Studio Code
- Use the Remote Explorer icon in the Activity Bar or View -> Command Palette and run Remote Explorer: Focus on Containers View to view containers
- Locate the terra-core_devcontainer under "Dev Containers"
- Hover over the dev container and click the Folder icon labelled Open Folder in Container or by right clicking and selecting Open Folder in Container
- Existing local workspace (for Option 1)
LICENSE
Copyright 2017 - 2019 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.