Git Product home page Git Product logo

git-appraise-web's Introduction

Git-Appraise Web UI

This repository contains a read-only web UI for git-appraise reviews.

Disclaimer

This is not an official Google product.

Prerequisites

Building requires the Go tools and GNU Make. Running the built binary requires the git command line tool.

Building the source code

Assuming you have the Go tools installed, run the following command:

go get github.com/google/git-appraise-web/git-appraise-web

Manual steps

Assuming you have not run the above command, first checkout the code from the git repo:

mkdir -p ${GOPATH}/src/github.com/google
cd ${GOPATH}/src/github.com/google
git clone https://github.com/google/git-appraise-web.git

Build the binary:

cd ${GOPATH}/src/github.com/google/git-appraise-web
make

Running the application

Binary is placed into ${GOPATH}/bin:

${GOPATH}/bin/git-appraise-web

The tool requires that it be started in a directory that contains at least one git repo, and it shows the reviews from every git repo under that directory.

The UI is a webserver which defaults to listening on port 8080. To use a different port, pass it as an argument to the "--port" flag:

${GOPATH}/bin/git-appraise-web --port=12345

Try it in App Engine

The repo includes a demo of the UI that runs in App Engine. You can try it out with your own project by running

gcloud app deploy --project ${PROJECT} demo/

Where ${PROJECT} is set to the ID of a GCP project you own.

git-appraise-web's People

Contributors

ajzaff avatar davidkuridza avatar ojarjur avatar philips avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

git-appraise-web's Issues

Support adding comments via the UI

This issue is meant to track what would be required for the first steps in making the UI able to edit reviews rather than just display them. There are no current plans to do this, but this issue is here to document what would need to be done if someone else wants to pick that up.

There are two scenarios to consider:

  1. A hosted instance of the web UI that is visible to multiple people. An example would be https://git-appraise-web.appspot.com
  2. A locally running instance that is only accessible to one person (e.g. http://localhost:${SOME_PORT}).

The first scenario would require a full user-management setup and all of the complexity that entails, so I would not recommend considering that one until the second scenario is addressed.

For the second scenario, I think we would need at least the following:

  1. A new UI component for drafting the comments along with a preview of the rendered markdown. I think the editor that StackOverflow has is the best example of such a thing.
  2. An API for adding the comments. This would essentially just be a URL where the UI component can POST a JSON encoding of the comment. Of course, this would also entail adding a handler for that URL path.
  3. A button in the UI to push the newly written comments to a selected remote repository.

The button for pushing review data to (and, implicitly, pulling it from) a remote repository would also be useful in its own right, so that is probably the bit that should be done first.

cannot find package "github.com/google/git-appraise-web/api" when running make

Cloning into 'git-appraise-web'...
remote: Counting objects: 445, done.
remote: Total 445 (delta 0), reused 0 (delta 0), pack-reused 445
Receiving objects: 100% (445/445), 378.44 KiB | 149.00 KiB/s, done.
Resolving deltas: 100% (250/250), done.
Checking connectivity... done.
~/OpenSource $ cd git-appraise-web/
~/OpenSource/git-appraise-web@master $ make
go get -u github.com/jteeuwen/go-bindata/...
go get -u github.com/google/git-appraise/...
rm assets/*~ 2>/dev/null || true
/Users/pablo/go/bin/go-bindata -modtime 1 -pkg assets -o third_party/assets/assets.go assets/
gofmt -w ./
go vet ./...
go test ./...
git-appraise-web/git-appraise-web.go:28:2: cannot find package "github.com/google/git-appraise-web/api" in any of:
        /usr/local/opt/go/libexec/src/github.com/google/git-appraise-web/api (from $GOROOT)
        /Users/pablo/go/src/github.com/google/git-appraise-web/api (from $GOPATH)
git-appraise-web/git-appraise-web.go:29:2: cannot find package "github.com/google/git-appraise-web/third_party/assets" in any of:
        /usr/local/opt/go/libexec/src/github.com/google/git-appraise-web/third_party/assets (from $GOROOT)
        /Users/pablo/go/src/github.com/google/git-appraise-web/third_party/assets (from $GOPATH)
make: *** [test] Error 1```

Live demo duplication

Just out of curiosity, I see a lot of comment duplication (comments left twice) in the live demo. What caused that? Is that likely to happen if we adopt this?

webkit only?

Currently it works only on webkit-based browser such as Chrome.
Firefox, IE, Edge do not work.
This is because Polymer is used.

Inappropriate alignment in Ubuntu-Chrome.

Inappropriate alignment in time and date field.
This is probably arising due to using of AM & PM for time formats. Can't you use the 24-hour clock system?
Please check in this regard.

screenshot from 2017-01-26 22 18 38

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.