Added Flags & Readme

Author: elwin

README.md

@@ -0,0 +1,13 @@
+# Wiki Index
+This project has been created to play around with the Wikipedia dataset.
+The goal is to calculate the distance between two pages, that is, how many clicks are required
+to get from one page to the other by only using the links on each page.
+
+First you should download the dataset, e.g. from [here](https://meta.wikimedia.org/wiki/Data_dump_torrents). Next, you can build and run the index:
+
+```bash
+go build
+./WikiIndex -i ~/Downloads/simplewiki-20170820-pages-meta-current.xml.bz2 
+```
+
+After that, you can reach the web interface with [http://localhost:8080](http://localhost:8080).

app/http.go

@@ -8,7 +8,7 @@ import (
 	"github.com/pkg/errors"
 )
 
-func (a *App) Serve() error {
+func (a *App) Serve(address string) error {
 	r := gin.Default()
 
 	r.GET("/", a.Root())
@@ -17,7 +17,7 @@ func (a *App) Serve() error {
 	r.GET("/longest", a.Longest())
 	//r.GET("/loooongest", a.LongestOverall())
 
-	return r.Run(":8080")
+	return r.Run(address)
 }
 
 func (a *App) Root() gin.HandlerFunc {

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/flosch/pongo2 v0.0.0-20190707114632-bbf5a6c351f4
 	github.com/gin-gonic/gin v1.4.0
 	github.com/gosimple/slug v1.9.0
+	github.com/jessevdk/go-flags v1.4.0
 	github.com/pkg/errors v0.8.1
 	github.com/stretchr/testify v1.3.0
 )

go.sum

@@ -32,6 +32,8 @@ github.com/gosimple/slug v1.9.0/go.mod h1:AMZ+sOVe65uByN3kgEyf9WEBKBCSS+dJjMX9x4
 github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4=
 github.com/hashicorp/golang-lru v0.0.0-20180201235237-0fb14efe8c47/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
+github.com/jessevdk/go-flags v1.4.0 h1:4IU2WS7AumrZ/40jfhf4QVDMsQwqA7VEHozFRrGARJA=
+github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
 github.com/jimstudt/http-authentication v0.0.0-20140401203705-3eca13d6893a/go.mod h1:wK6yTYYcgjHE1Z1QtXACPDjcFJyBskHEdagmnq3vsP8=
 github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
 github.com/juju/errors v0.0.0-20181118221551-089d3ea4e4d5 h1:rhqTjzJlm7EbkELJDKMTU7udov+Se0xZkWmugr6zGok=

main.go

@@ -7,14 +7,13 @@ import (
 	"log"
 	"os"
 
-	_ "github.com/flosch/pongo2"
+	"github.com/jessevdk/go-flags"
 )
 
-
-//const filename = "testdata/enwiki-20190101-pages-articles-multistream.xml.bz2"
-const filename = "testdata/simplewiki-20170820-pages-meta-current.xml.bz2"
-//const filename = "testdata/sample.xml"
-
+var options struct {
+	Filename string `short:"i" long:"input" description:"Wikipedia XML dump (something ending in .xml.bz2)" required:"true"`
+	Address  string `short:"h" long:"http" description:"HTTP address" default:":8080"`
+}
 
 func main() {
 	if err := run(); err != nil {
@@ -23,9 +22,14 @@ func main() {
 }
 
 func run() error {
+	_, err := flags.Parse(&options)
+	if err != nil {
+		os.Exit(1)
+	}
+
 	app := app.New()
 
-	f, err := os.Open(filename)
+	f, err := os.Open(options.Filename)
 	if err != nil {
 		return err
 	}
@@ -39,5 +43,5 @@ func run() error {
 		f.Close()
 	}()
 
-	return app.Serve()
-}
+	return app.Serve(options.Address)
+}

view/index.html

@@ -50,7 +50,7 @@ <h5 class="card-title">Least referenced page</h5>
 
     </div>
 
-    <h4>What can you do here?</h4>
+    <h4 class="mb-3">What can you do here?</h4>
 
     <div class="row">