Skip to content

This project includes documentation and examples for the FDNS React UI Library.

Notifications You must be signed in to change notification settings

CDCgov/fdns-ui-react-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FDNS React UI Library Documentation

This project includes documentation for the FDNS React UI Library. The purpose of this app is to provide a visualization and documentation of all the components created using the fdns-ui-react library. This app can be used as a way of perusing the existing components or as a means to view how updates to the fdns-ui-react library affect these components. You can see which version of fdns-ui-react this is running in the package.json or at the top of the page when you run the app.

For more information about Foundation Services (FDNS) including links to example apps utilizing these components, please reference the fdns repository.

Running locally

Please read the following instructions carefully for information on how to run and test this app in your local environment.

Before you start

You will need to have the following dependencies installed before getting up and running locally:

Run

You can run this project locally by following the below instructions:

npm install
npm start

You should be able to visit http://localhost:3001/ to view the dashboard.

Public Domain

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

License

The repository utilizes code licensed under the terms of the Apache Software License 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 under the terms of the Apache Software License version 2, or (at your option) any later version.

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

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

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

Privacy

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Surveillance Platform Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/privacy.html.

Contributing

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page are subject to the Presidential Records Act and may be archived. Learn more at https://www.cdc.gov/other/privacy.html.

Records

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.

About

This project includes documentation and examples for the FDNS React UI Library.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published