terra-ui

Documentation site for Terra. Terra is the core UI component library, unifying UX concepts and development across Cerner.

• Getting Started
  • Install Application
  • Run Application
  • Test Application
  • Local Development using Docker (Dev Containers)
• Supported Browsers
• Contributing
• LICENSE

Getting Started

Install Application

git clone https://github.com/cerner/terra-ui.git

npm install

Run Application

npm run start

Test Application

npm run test

Local Development using Docker

1. Install Rancher or Docker.
   • Rancher is free and open-source and is highly recommended whereas Docker may require a license for use.
2. Install Microsoft VS Code.
3. 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
4. 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.
5. 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.
6. 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-ui_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
7. 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-ui_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

Supported Browsers

Browser	Version
Chrome & Chrome for Android	Current
Edge	Current
Firefox	Current
Internet Explorer	10 & 11
Safari & Mobile Safari	Current

Contributing

Please read through our contributing guidelines. Included are directions for issue reporting and pull requests.

LICENSE

Copyright 2017 - 2020 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.