cfpb / code-inventory-generator

A web app for generating an inventory of an organization's software projects.
https://code.gov/#/policy-guide/docs/compliance/inventory-code
Creative Commons Zero v1.0 Universal
2 stars 5 forks source link

code.gov inventory generator

A web app for generating an inventory of an organization's software projects.

Demo: https://code-json.now.sh/?org=cfpb

Installation

  1. Generate a GitHub personal access token with public_repo and read:org permissions.
  2. cp .env.sample .env and add your token. source .env
  3. npm install
  4. npm start
  5. Visit http://localhost:3000?org=cfpb.
  6. If there are greater than 100 results, pass the query's endCursor as an after parameter in the url to get the next page of results, e.g. http://localhost:3000?org=cfpb&after=Y3Vyc29yOnYyOpHOA/2KeA==

Deployment

  1. npm run deploy

now will serve the app at a public URL.

Open source licensing info

  1. TERMS
  2. LICENSE
  3. CFPB Source Code Policy