$ git clone [email protected]:coforma/co-regulations-gov.git
$ cd co-regulations-gov
$ yarn install

1. Go to https://open.gsa.gov/api/regulationsgov/ and request an API KEY. The API KEY should arrive by email within a few minutes.

2. In ./workspaces/api make a copy of .env-example as .env and add your API KEY.

3. In ./workspaces/ui, make a copy of .env-example as .env

You'll need the parent Document ID which may be obtained by navigating to that particular Document on regulations.gov.

Then, in the project root, run:

$ yarn start

You can now use the interface at: http://localhost:3000/

Try NHTSA-2021-0001 to test.

Running the following command in the project root:

$  yarn cli --documentId={DOCUMENT_ID}

Will generate results to output/output-{DOCUMENT_ID}.csv & output-{DOCUMENT_ID}.json.

Though the script does account for rate limits, it doesn't do so exhaustively. The API's current rate limit is 500 per hour. Consequently, if there are over ~475 comments, it will likely begin to fail at some point.

We welcome any/all feedback/comments, including the creation of Issues and/or Pull requests to this repository.

Please direct any non-code feedback to: https://coforma.io/connect/