Skip to content

Commit

Permalink
Add steps to get a basic server running.
Browse files Browse the repository at this point in the history
Fixes issue daviddengcn#3.
  • Loading branch information
mipearson committed Mar 11, 2014
1 parent df7866f commit 2a9746d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,20 @@ Sub packages are commands for running:
* [MergeDocs](http://github.com/daviddengcn/gcse/mergedocs): Merge crawled package files with doc DB.
* [Indexer](http://github.com/daviddengcn/gcse/indexer): Analyzing package information and generating indexed data for searching.

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. Visit [http://localhost:8080](http://localhost:8080) in your browser


LICENSE
-------
BSD license.

0 comments on commit 2a9746d

Please sign in to comment.