@newjersey/njwds 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 New Jersey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,30 @@
+# NJ Web Design Standards
+
+The NJ Web Design Standards are an extension of the [US Web Design Standards](https://github.com/uswds/uswds/) with a specific theme and components for State of New Jersey digital properties and services.
+
+## Initial set up
+
+* Clone this repository
+* Run `npm install`
+* [Optional] Run `npm run import-components` to important new USWDS components. This only needs to be done if new upstream components are developed
+
+This imports the USWDS, pulls in the NJ-specific components and styles, and saves them in a `dist` directory.
+
+
+
+## Build the component library
+
+* Run `npm run build-docs` to general a [Fractal]() component gallery for reviewing the style guide
+
+
+## View component library locally or development
+
+* Run `npm start` to build the component library, launch a web server to host it, and live reload on development changes.
+
+## Deploy the component library
+
+* Run `npm run deploy`
+
+This builds USWDS styles, builds the Fractal docs, and then deploys them to the gh-pages branch.
+
+Note: do not push directly to the gh-pages branch.