dotgov-components

UI design system for Baltimore County's primary website.

Getting Started

1. Clone this repo
2. Run npm install
3. Take a look at our Getting Started Guide

npm start

Runs the design system in development mode. Open http://localhost:6060/ in your browser to view it. The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.

Note: When adding a markdown file for a component you will need to restart.

npm run test and npm run-script test:watch

Runs tests for the project. If you wish to watch the tests, use the watch command.

npm login and npm publish

Logs into npm registry.npmjs.org. This is required to publish. Once logged in npm publish will push out the latest version of the application.

npm run-script deploy locally

This will push the latest build to https://baltimorecounty.github.io/dotgov-components/

Usage

npm i @baltimorecounty/dotgov-components

Including Styles

Javascript

import "@baltimorecounty/dotgov-components/lib/styles/dotgov.min.css";

Note: To generate dotgov.min.css => npm run generate-css Note: This import should be included your primary js file. Example App.js in a create react app.

Including Components

Available components can be found in our docs.

import {
  FormField,
  TextInput,
  TextArea,
} from "@baltimorecounty/dotgov-components";