Improve DevDocs

README.md

@@ -21,13 +21,18 @@ Development
 You'll need to perform the following steps to get a basic server running:
 
   1. Create a basic `conf.json` file, limiting the crawler to a one minute run: `{ "crawler": { "due_per_run": "1m" } }`
-  1. Run the package finder: `go run tocrawl/*.go`
-  1. Run the crawler: `go run crawler/*.go`
-  1. Merge the crawled docs: `go run mergedocs/*.go`
-  1. Run the indexer: `go run indexer/*.go`
-  1. Run the server: ` go run server/*.go`
+  1. Create the data dir: `mkdir -p data/docs`
+  1. Run the package finder: `go run pipelines/tocrawl/*.go`
+  1. Run the crawler: `go run pipelines/crawler/*.go`
+  1. Merge the crawled docs: `go run pipelines/mergedocs/*.go`
+  1. Run the indexer: `go run pipelines/indexer/*.go`
+  1. Run the server:
+    - `go install ./server`
+    - `$GOPATH/bin/server`
   1. Visit [http://localhost:8080](http://localhost:8080) in your browser
 
+You can also use the `bootstrap.sh` script to get you started!
+
 
 LICENSE
 -------

bootstrap.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+cd "$(dirname $0)"
+
+set -e
+
+# create config
+if [ ! -f conf.json ]; then
+  echo '{ "crawler": { "due_per_run": "1m" } }' > config.json
+fi
+
+# create neccessary directories
+mkdir -p data/docs
+
+# install dependencies
+go get github.com/daviddengcn/gcse
+go get github.com/golangplus/fmt
+go get github.com/golangplus/container/heap
+
+echo '---> Running package finder...'
+echo '     This may take a few minutes'
+go run pipelines/tocrawl/*.go
+
+echo '---> Running crawler...'
+go run pipelines/crawler/*.go
+
+echo '---> Merging docs...'
+go run pipelines/mergedocs/*.go
+
+echo '---> Running indexer...'
+go run pipelines/indexer/*.go
+
+echo '---> Thats it!'
+echo '     To start the webserver, call ./server.sh'

conf.json.template

@@ -1,32 +1,32 @@
 {
-    web: {
-        // addr: ":8080"
-        // root: "./server/"
-	// loadtemplatepass: ""
-	// autoloadtemplate: false
-    }
+  "web": {
+    //"addr": ":8080",
+    //"root": "./server/",
+    //"loadtemplatepass": "",
+    //"autoloadtemplate": false
+  },
 
-    back: {
-        // dbroot: "./data/"
-    }
+  "back": {
+    //"dbroot": "./data/"
+  },
 
-    crawler: {
-        // due_per_run: "1h"
-        // godoc: true
-        // github_update: true
-		// noncrawl_hosts: []
-		// github: {
-		// 	clientid: ""
-		// 	clientsecret: ""
-		// }
-    }
+  "crawler": {
+    //"due_per_run": "1h",
+    //"godoc": true,
+    //"github_update": true,
+    //"noncrawl_hosts": [],
+    //"github": {
+    //  "clientid": "",
+    //  "clientsecret": "",
+    //}
+  },
 
-	docdb: {
-		// nonstore_regexps: []
-	}
+  "docdb": {
+    //"nonstore_regexps": [],
+  },
 
-	bi: {
-		// data_path: "/tmp/gcse.bolt"
-		// web_path: "/bi"
-	}
+  "bi": {
+    //"data_path": "/tmp/gcse.bolt",
+    //"web_path": "/bi",
+  }
 }

server.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+# build and run the local server
+
+cd "$(dirname $0)"
+go install ./server
+exec $GOPATH/bin/server