{"id":13764829,"url":"https://github.com/valueadd-poland/pimp-my-pr","last_synced_at":"2025-05-10T20:31:14.786Z","repository":{"id":36741966,"uuid":"221233831","full_name":"valueadd-poland/pimp-my-pr","owner":"valueadd-poland","description":"A brilliant tool that will pimp your pull requests by collecting and presenting PR statistics.","archived":false,"fork":false,"pushed_at":"2023-01-24T06:18:26.000Z","size":7319,"stargazers_count":101,"open_issues_count":37,"forks_count":18,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-17T01:32:25.444Z","etag":null,"topics":["angular","nestjs","presenting-pr-statistics"],"latest_commit_sha":null,"homepage":"https://pimpmypr.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/valueadd-poland.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-12T14:12:37.000Z","updated_at":"2024-09-01T13:55:58.000Z","dependencies_parsed_at":"2023-02-13T18:32:10.046Z","dependency_job_id":null,"html_url":"https://github.com/valueadd-poland/pimp-my-pr","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valueadd-poland%2Fpimp-my-pr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valueadd-poland%2Fpimp-my-pr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valueadd-poland%2Fpimp-my-pr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valueadd-poland%2Fpimp-my-pr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/valueadd-poland","download_url":"https://codeload.github.com/valueadd-poland/pimp-my-pr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253480401,"owners_count":21915246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","nestjs","presenting-pr-statistics"],"created_at":"2024-08-03T16:00:29.857Z","updated_at":"2025-05-10T20:31:09.754Z","avatar_url":"https://github.com/valueadd-poland.png","language":"TypeScript","funding_links":[],"categories":["Projects using NestJS"],"sub_categories":[],"readme":"# ![PMP Logo](docs/img/pmp-logo.svg)\n\n[![build](https://github.com/valueadd-poland/pimp-my-pr/workflows/PMP%20MASTER%20CI/badge.svg)](https://github.com/valueadd-poland/pimp-my-pr/actions?query=workflow%3A%22PMP+MASTER+CI%22)\n\n![PMP Image](docs/img/pmp-image.png)\n\nA brilliant tool that will pimp your pull requests by collecting and presenting PR statistics.\n\n![PMP Screen](docs/img/pmp-preview.png)\n\n### Setup\n\n- copy `.env-sample` file as `.env` in project root\n- fill the `.env` file\n\nGenerate repository platform client credentials:\n\n#### Github\n\n- register application at https://github.com/settings/applications/new\n- Set callback URL as `http://your.pmp.domain/login?platform=github`\n\n#### Bitbucket\n\nRegister application:\n\n- Go to account settings\n- Find \"Access management\" group\n- Go to \"OAuth\"\n- Add OAuth consumer with \"Add consumer\" button\n  You can find out more at https://confluence.atlassian.com/x/pwIwDg\n- Set callback URL as `http://your.pmp.domain/login?platform=bitbucket`\n- Add Permissions to `Account:read`, `Repositories:read` and `Pull requests:read`\n\n#### Gitlab\n\nRegister application:\n\n- Go to account settings\n- Find \"Applications\" group\n- Add new application, setting following options\n  Set Redirect URI as `http://your.pmp.domain/login?platform=gitlab`\n  Select scopes `read_user`, `read_repository` and `read_api`\n\n## Development\n\n- install dependencies with `npm install`\n- run `node ./scripts/init.js`\n  or manually copy all sample files under `apps/pmp-web/src/assets/env/` directory\n  without `.sample` key word and fill that files with proper configuration\n- serve frontend application with `ng serve`\n- (optional) start a database with docker `docker run --name pmp-postgres -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_USER=pmp -p 5432:5432 -d postgres`\n- serve api with `ng serve pmp-api`\n\n### Build production\n\n- install dependencies `npm install`\n- build frontend application `npm run build:pmp-web:prod`\n- build api `npm run build:pmp-api:prod`\n\n## Production Server Setup\n\n- clone the repository or copy just .env-sample and docker-compose.yml files to your device.\n- go through the Setup section steps\n- run `docker-compose up -d`\n\n### SWAGGER\n\nAPIs specification is available in swagger under the `/api` endpoint on the running pmp-api application.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalueadd-poland%2Fpimp-my-pr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalueadd-poland%2Fpimp-my-pr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalueadd-poland%2Fpimp-my-pr/lists"}