Skip to content

PullKeeper - app for getting relevant stats about PRs and reviewers

License

Notifications You must be signed in to change notification settings

kortirso/pullmetry

Repository files navigation

PullKeeper

Application for getting relevant stats about PRs and reviewers

Installation

$ bundle install
$ rails db:create
$ rails db:schema:load
$ rails db:seed
$ yarn install
$ EDITOR=vim rails credentials:edit

Credentials

If you would like to run application locally or on your production server you need to generate new config/master.key and use config/credentials.yml.example for updating config/credentials.yml.enc with your api keys.

Running application locally

foreman s

Running application locally in production environment

For running production env locally you can call

bin/local-production

Testing

Unit tests

$ rspec

E2E tests

With browser

$ rails server -e test -p 5002
$ yarn cypress open --project ./spec/e2e

Headless

$ rails server -e test -p 5002
$ yarn run cypress run --project ./spec/e2e

Sensitive information leaks

$ bearer scan . --skip-rule javascript_react_dangerously_set_inner_html,javascript_lang_insufficiently_random_values

Application layers

contracts - model schemas for validators schemas - model schemas for validating controller params validators - model validations forms - service object to interact with user form input

deliveries, notifiers - delivery layer with different providers

queries - separated database queries services - business logic layer policies - authorization logic

License

The source code is available as open source under the terms of the MIT License.