https://github.com/zapthedingbat/repository-report
Automated maturity model classification for code repositories
https://github.com/zapthedingbat/repository-report
Last synced: over 1 year ago
JSON representation
Automated maturity model classification for code repositories
- Host: GitHub
- URL: https://github.com/zapthedingbat/repository-report
- Owner: zapthedingbat
- Created: 2018-11-10T12:49:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T19:15:50.000Z (over 1 year ago)
- Last Synced: 2025-03-09T00:44:36.245Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 382 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Repository Report
Automated maturity model classification for code repositories
## Installation
```
$ npm install
```
## Usage
Currently only github is supported. although integration with other version
control systems like gitLab or BitBucket should be feasible.
### Github Integration
To communicate with github the service needs to sign requests using the AppID
and private key that was generated when the application is registered with
github.
- Set the `GITHUB_APPID` environment variable
- Save the private key file as `/.keys/github-private-key.pem`
### Running locally
#### Config
Create a `.env` file with the following format `GITHUB_APPID=xxxx` (where `xxxx`
is your registered app id)
#### Run
```
$ npm start
```
### Running in Docker
#### Build the docker image
```
$ docker build -t github-tech-report:latest .
```
#### Run the image
Mount the public key file under `/home/app/.keys`
```
$ docker run github-tech-report
```
## Contributing
Pull requests are very welcome from anyone.