https://github.com/valueadd-poland/pimp-my-pr

A brilliant tool that will pimp your pull requests by collecting and presenting PR statistics.
https://github.com/valueadd-poland/pimp-my-pr

angular nestjs presenting-pr-statistics

Last synced: 3 months ago
JSON representation

A brilliant tool that will pimp your pull requests by collecting and presenting PR statistics.

• Host: GitHub
• URL: https://github.com/valueadd-poland/pimp-my-pr
• Owner: valueadd-poland
• License: mit
• Created: 2019-11-12T14:12:37.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T06:18:26.000Z (almost 2 years ago)
• Last Synced: 2024-04-18T03:50:53.320Z (7 months ago)
• Topics: angular, nestjs, presenting-pr-statistics
• Language: TypeScript
• Homepage: https://pimpmypr.io/
• Size: 6.98 MB
• Stars: 94
• Watchers: 8
• Forks: 18
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-nestjs - Pimp My PR - Open-Source platform for statistics and pull request management. (Projects using NestJS)

README

        
# ![PMP Logo](docs/img/pmp-logo.svg)

[![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)

![PMP Image](docs/img/pmp-image.png)

A brilliant tool that will pimp your pull requests by collecting and presenting PR statistics.

![PMP Screen](docs/img/pmp-preview.png)

### Setup

- copy `.env-sample` file as `.env` in project root

- fill the `.env` file

Generate repository platform client credentials:

#### Github

- register application at https://github.com/settings/applications/new

- Set callback URL as `http://your.pmp.domain/login?platform=github`

#### Bitbucket

Register application:

- Go to account settings

- Find "Access management" group

- Go to "OAuth"

- Add OAuth consumer with "Add consumer" button

  You can find out more at https://confluence.atlassian.com/x/pwIwDg

- Set callback URL as `http://your.pmp.domain/login?platform=bitbucket`

- Add Permissions to `Account:read`, `Repositories:read` and `Pull requests:read`

#### Gitlab

Register application:

- Go to account settings

- Find "Applications" group

- Add new application, setting following options

  Set Redirect URI as `http://your.pmp.domain/login?platform=gitlab`

  Select scopes `read_user`, `read_repository` and `read_api`

## Development

- install dependencies with `npm install`

- run `node ./scripts/init.js`

  or manually copy all sample files under `apps/pmp-web/src/assets/env/` directory

  without `.sample` key word and fill that files with proper configuration

- serve frontend application with `ng serve`

- (optional) start a database with docker `docker run --name pmp-postgres -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_USER=pmp -p 5432:5432 -d postgres`

- serve api with `ng serve pmp-api`

### Build production

- install dependencies `npm install`

- build frontend application `npm run build:pmp-web:prod`

- build api `npm run build:pmp-api:prod`

## Production Server Setup

- clone the repository or copy just .env-sample and docker-compose.yml files to your device.

- go through the Setup section steps

- run `docker-compose up -d`

### SWAGGER

APIs specification is available in swagger under the `/api` endpoint on the running pmp-api application.