https://github.com/cfpb/code-inventory-generator
A web app for generating an inventory of an organization's software projects.
https://github.com/cfpb/code-inventory-generator
Last synced: 11 months ago
JSON representation
A web app for generating an inventory of an organization's software projects.
- Host: GitHub
- URL: https://github.com/cfpb/code-inventory-generator
- Owner: cfpb
- License: cc0-1.0
- Created: 2017-06-06T19:47:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-01T22:12:09.000Z (almost 8 years ago)
- Last Synced: 2025-06-26T16:09:17.640Z (11 months ago)
- Language: JavaScript
- Homepage: https://code.gov/#/policy-guide/docs/compliance/inventory-code
- Size: 21.5 KB
- Stars: 2
- Watchers: 9
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# code.gov inventory generator
A web app for generating an [inventory](https://code.gov/#/policy-guide/docs/compliance/inventory-code) of an organization's software projects.
Demo: https://code-json.now.sh/?org=cfpb
## Installation
1. Generate a [GitHub personal access token](https://github.com/settings/tokens) with `public_repo` and `read:org` permissions.
1. `cp .env.sample .env` and add your token. `source .env`
1. `npm install`
1. `npm start`
1. Visit http://localhost:3000?org=cfpb.
1. 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](https://zeit.co/now) will serve the app at a public URL.
## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)