Repository files navigation

This repository contains a front-end library built in React. The library is designed to help developers efficiently build user interfaces on top of the Foundation Services. The library ispre-release software and being made public to gain feedback from the open source community.

Carefully read the following instructions on how to run and test this library in your local environment.

You will need to have the following software installed to run this library locally:

• Node.js
• Windows Users: Please useCygwin or theWindows Subsystem for Linux for running the commands in this README

Create your project withcreate-react-app.

create-react-app my-appcd my-appnpm install --save fdns-ui-react

Open upsrc/App.js in your text editor of choice and include the React components:

importReact,{Component}from'react';import{SuperGrid,fixtures}from'fdns-ui-react';importlogofrom'./logo.svg';import'./App.css';// grab some test fixturesconst{ headers, messages}=fixtures;classAppextendsComponent{render(){return(<divclassName="App"><headerclassName="App-header"><imgsrc={logo}className="App-logo"alt="logo"/><h1className="App-title">Welcome to React</h1></header><SuperGriddata={messages}headers={headers}/></div>);}}exportdefaultApp;

Start your project:

npm start

Openhttp://localhost:3000/ in a web browser and view your Grid. You can now add any components in the library into your application.

This library currently usesreact-styleguidist to document and view examples of the various components.

To view the StyleGuide, after runningnpm i, use the command:

npm start

ornpx styleguidist server. This will run the styleguide onhttp://localhost:6060/.

This repository constitutes a work of the United States Government and is notsubject to domestic copyright protection under 17 USC § 105. This repository is inthe public domain within the United States, and copyright and related rights inthe work worldwide are waived through theCC0 1.0 Universal public domain dedication.All contributions to this repository will be released under the CC0 dedication. Bysubmitting a pull request you are agreeing to comply with this waiver ofcopyright interest.

The repository utilizes code licensed under the terms of the Apache SoftwareLicense and therefore is licensed under ASL v2 or later.

The source code in this repository is free: you can redistribute it and/or modify it underthe terms of the Apache Software License version 2, or (at your option) anylater version.

The source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANYWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR APARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with thisprogram. If not, seehttps://www.apache.org/licenses/LICENSE-2.0.html.

The source code forked from other open source projects will inherit its license.

This repository contains only non-sensitive, publicly available data andinformation. All material and community participation is covered by theSurveillance PlatformDisclaimerandCode of Conduct.For more information about CDC's privacy policy, please visithttps://www.cdc.gov/privacy.html.

Anyone is encouraged to contribute to the repository byforkingand submitting a pull request. (If you are new to GitHub, you might start with abasic tutorial.) By contributingto this project, you grant a world-wide, royalty-free, perpetual, irrevocable,non-exclusive, transferable license to all users under the terms of theApache Software License v2 orlater.

All comments, messages, pull requests, and other submissions received throughCDC including this GitHub page are subject to thePresidential Records Actand may be archived. Learn more athttps://www.cdc.gov/other/privacy.html.

This repository is not a source of government records, but is a copy to increasecollaboration and collaborative potential. All government records will bepublished through theCDC web site.

Please refer toCDC's Template Repositoryfor more information aboutcontributing to this repository,public domain notices and disclaimers,andcode of conduct.