Skip to content
This repository has been archived by the owner on Jul 26, 2021. It is now read-only.
/ terra-dev-site Public archive

A development environment for React UI components for documentation and testing

License

Notifications You must be signed in to change notification settings

cerner/terra-dev-site

Repository files navigation

terra logo

Terra Dev Site

NPM version Cerner OSS License Build Status Dependencies status devDependencies status

This repo is archived and active development has moved to terra-application.

Dynamically builds a site based on site configuration, navigation configuration and page configuration.

The provided webpack plugin includes a call to the generateAppConfig script. The generateAppConfig script builds out static config to the ./dev-site-config/build folder. generateAppConfig also discovers pages based on it's configuration. After the static config has been built webpack continues to run, pulling in the static config, and producing the webpack bundle.

Provides the following default configuration:

Getting Started

  • Install with npm: npm install --save-dev terra-dev-site

Peer Dependencies

This component requires the following peer dependencies be installed in your app for the component to properly function.

Peer Dependency Version
react ^16.8.5
react-dom ^16.8.5
terra-toolkit ^5.2.0
webpack ^4.28.1

Versioning

terra-dev-site is considered to be stable and will follow SemVer for versioning.

  1. MAJOR versions represent breaking changes
  2. MINOR versions represent added functionality in a backwards-compatible manner
  3. PATCH versions represent backwards-compatible bug fixes

Consult the component CHANGELOGs, related issues, and PRs for more information.

Contributing

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

LICENSE

Copyright 2018 - 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.