generator-jhipster-uswds-react

JHipster blueprint, React components for the USWDS design system

Introduction

This is a JHipster blueprint, that is meant to be used in a JHipster application.

Prerequisites

As this is a JHipster blueprint, we expect you have JHipster and its related tools already installed:

• Installing JHipster

Installation

With NPM

To install this blueprint:

npm install -g generator-jhipster-uswds-react

To update this blueprint:

npm update -g generator-jhipster-uswds-react

With Yarn

To install this blueprint:

yarn global add generator-jhipster-uswds-react

To update this blueprint:

yarn global upgrade generator-jhipster-uswds-react

Usage

To use this blueprint, run the below command

jhipster --blueprint uswds-react

Running local Blueprint version for development

Using Scripts

From generate-jhipster-uswds-react you can run two scripts to aid in development:

• ./scripts/generate.sh
• ./scripts/run.sh

Manually Generate

During development of blueprint, please note the below steps for manual generation.

1. Link your blueprint globally

Note: If you do not want to link the blueprint(step 3) to each project being created, use NPM instead of Yarn as yeoman doesn't seem to fetch globally linked Yarn modules. On the other hand, this means you have to use NPM in all the below steps as well.

cd uswds-react
npm link

2. Link a development version of JHipster to your blueprint (optional: required only if you want to use a non-released JHipster version, like the master branch or your own custom fork)

You could also use Yarn for this if you prefer

cd generator-jhipster
npm link

cd uswds-react
npm link generator-jhipster

3. Create a new folder for the app to be generated and link JHipster and your blueprint there

mkdir my-app && cd my-app

npm link generator-jhipster-uswds-react
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)

jhipster -d --blueprint uswds-react

Debugging

Debugging is available in VSCode via the tasks and launch properties defined in .vscode.

IMPORTANT: To run, first make a directory (a sibling of this repo) and name it debugVsCodeFolder.

In VSCode, Run -> Start Debugging

License

Apache-2.0 © Joseph Shannon