README
¶
Github Aggregator
Aggregator is an application that represents GitHub Pull Requests and Activity stream in a more configurable and detailed way. It helps organize code review process by monitoring events from organizations and projects, structuring and aggregating them in the fashion that fits a user best.
Installation
Default
First of all you need to install:
Then you need to make following steps:
-
Make directory src/github.com/777777miSSU7777777 in $GOPATH:
mkdir -p src/github.com/777777miSSU7777777 && cd src/github.com/777777miSSU7777777 -
Clone git repository:
git clone https://github.com/777777miSSU7777777/github-aggregator.git -
Build application:
go build cmd/web-app/main.go
Docker
You need to install docker. Then pull docker image from dockerhub:
docker pull 777777missu7777777/github-aggregator-web
Usage
Default
Run compiled binary:
./main
Docker
Run pulled image in container:
docker run -p 8080:8080 777777missu7777777/github-aggregator-web
Common
Then go to 127.0.0.1:8080 in browser to use application.
Notice: you need browser with ES6 support.
Supported cmd flags
- -host -h - defines host ip (default is 0.0.0.0).
- -port -p - defines host port (default is 8080).
- -data-source - defines data source (default is "rest-api").
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
web-app
command
|
|
|
internal
|
|
|
api
Package api implements functions for github aggregator rest api.
|
Package api implements functions for github aggregator rest api. |
|
view
Package view parses html templates for web version of github aggregator.
|
Package view parses html templates for web version of github aggregator. |
|
view/index
Package index implements function for index page render.
|
Package index implements function for index page render. |
|
view/login
Package login implements function for login page render.
|
Package login implements function for login page render. |
|
view/pulls
Package pulls implements function for pull requests page render.
|
Package pulls implements function for pull requests page render. |
|
pkg
|
|
|
encoding/base64util
Package base64util implements functions for string decoding and bytes encoding in base64 encoding.
|
Package base64util implements functions for string decoding and bytes encoding in base64 encoding. |
|
encoding/jsonutil
Package jsonutil implements function for unmarshalling data to map.
|
Package jsonutil implements function for unmarshalling data to map. |
|
entity
Package entity contains entities for github aggregator application.
|
Package entity contains entities for github aggregator application. |
|
factory/orgsfactory
Package orgsfactory contains a factory for array of Organizations.
|
Package orgsfactory contains a factory for array of Organizations. |
|
factory/prsfactory
Package prsfactory contains a factory for array of Pull Requests.
|
Package prsfactory contains a factory for array of Pull Requests. |
|
factory/reposfactory
Package reposfactory contains a factory for array of Repositories.
|
Package reposfactory contains a factory for array of Repositories. |
|
factory/userfactory
Package userfactory contains a factory for user entity.
|
Package userfactory contains a factory for user entity. |
|
http/bodyutil
Package bodyutil implements functions for working with body of http request/response.
|
Package bodyutil implements functions for working with body of http request/response. |
|
http/cookieutil
Package cookieutil implements functions for working with http cookie.
|
Package cookieutil implements functions for working with http cookie. |
|
http/headerutil
Package headerutil implements functions for working with heade of http request/response.
|
Package headerutil implements functions for working with heade of http request/response. |
|
io/fileutil
Package fileutil implements utility functions for working with files.
|
Package fileutil implements utility functions for working with files. |
|
log
Package log contains an interface for loggers, implentation for JSONLogger and factory for it, constants for logging levels, entity for log records and factory for it, and util functions for logging.
|
Package log contains an interface for loggers, implentation for JSONLogger and factory for it, constants for logging levels, entity for log records and factory for it, and util functions for logging. |
|
log/logfactory
Package logfactory contains a factory for LogRecord entity.
|
Package logfactory contains a factory for LogRecord entity. |
|
log/logger
Package logger contains an interface for loggers.
|
Package logger contains an interface for loggers. |
|
log/loggerfactory
Package loggerfactory contains factories for implementations of Logger interface.
|
Package loggerfactory contains factories for implementations of Logger interface. |
|
log/logutil
Package logutil implements util functions for logging.
|
Package logutil implements util functions for logging. |
|
query
Package query implements functions for working with Github API.
|
Package query implements functions for working with Github API. |
Click to show internal directories.
Click to hide internal directories.