Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.43 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.43 KB

Go Search GoSearch

A keyword search engine helping people to find popular and relevant Go packages.

Online service: Go Search

This is the root package with shared functions.

Sub packages are commands for running:

  • HTTP Server: Searching and web service
  • ToCrawl: Find packages to crawl.
  • Crawler: Crawling package files.
  • MergeDocs: Merge crawled package files with doc DB.
  • 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" } }
  2. Run the package finder: go run cmd/tocrawl/*.go
  3. Run the crawler: go run cmd/crawler/*.go
  4. Merge the crawled docs: go run cmd/mergedocs/*.go
  5. Run the indexer: go run cmd/indexer/*.go
  6. Run the server: go run cmd/server/*.go
  7. Visit http://localhost:8080 in your browser

LICENSE

BSD license.