Git Product home page Git Product logo

uspto-ds-theme's Introduction

USPTO Design System v2.x Theme (usptostrap)

The USPTO's Design System Theme, an open source design library based on the United States Web Design System (USWDS) and Bootstrap 4.

We welcome your feedback on this design library!

  • Supporting an older and/or legacy application? Take a look at version 1.x of our UI Design Library.
  • Looking for UX tools and assets to support software development? Check out our UX resources site.

Installing

Install the project's dependencies with:

npm install


Building & running locally

This project can be built with SASS.

To build the front-end assets (fonts/CSS/JS) use:

npm run build

To watch sass files while making changes locally use:

npm run dev

Using the USPTO Design System

How you implement the USPTO Design System depends on the needs of your project.

(Preferred) As a dependency within NPM:

Add the following to your package.json file:

"dependencies": {
  "bootstrap": "^4.6.0",
  "usptostrap": "^2.2.10"
  }

Adding directly:

npm install usptostrap

(Alternative) Add the precompiled theme to your site or application:

  • Download the lastest source code.
  • Copy the /assets to the root folder to your project.
  • Add the following code to the head of your HTML pages or templates:
<!-- USPTO Design System v2.x Theme -->
<link rel="stylesheet" href="assets/css/usptostrap.css">
<!-- Optional libraries -->
<link rel="stylesheet" href="assets/css/uswds-combobox.css">
<link rel="stylesheet" href="assets/css/uswds-datepicker.css">
<link rel="stylesheet" href="assets/css/uswds-overrides.css">

Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided on an "as-is" basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States government.


Acknowledgments

  • U.S. Web Design Standards (USWDS)
  • Bootstrap 4 and bootstrap icons
  • Material icons

uspto-ds-theme's People

Contributors

menka-uspto avatar menkakayan avatar scottmerker avatar zoinamir avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

uspto-ds-theme's Issues

Examples?

I'm looking to see if there are any examples out there already using this theme.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.