gcse

module

v0.0.0-...-a103e92 Latest Latest Go to latest Published: Jan 22, 2018 License: BSD-2-Clause, BSD-3-Clause

Details

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.

You'll need to perform the following steps to get a basic server running:

Create a basic conf.json file, limiting the crawler to a one minute run: { "crawler": { "due_per_run": "1m" } }
Run the package finder: go run cmd/tocrawl/*.go
Run the crawler: go run cmd/crawler/*.go
Merge the crawled docs: go run cmd/mergedocs/*.go
Run the indexer: go run cmd/indexer/*.go
Run the server: go run cmd/server/*.go
Visit http://localhost:8080 in your browser

BSD license.

Path	Synopsis
cmd
crawler command GCSE Crawler background program.	GCSE Crawler background program.
indexer command
mergedocs command Input	Input
server command GCSE HTTP server.	GCSE HTTP server.
spider command
tocrawl command
tools/countdocs command
tools/dump command
tools/exps command
tools/fillfound command
tools/fixcrawldb command
pkg Package gcse is the core supporting library for go-code-search-engine (GCSE).	Package gcse is the core supporting library for go-code-search-engine (GCSE).
configs Package configs define and load all configurations.	Package configs define and load all configurations.
proto/spider Package sppb is a generated protocol buffer package.	Package sppb is a generated protocol buffer package.
proto/store Package stpb is a generated protocol buffer package.	Package stpb is a generated protocol buffer package.
spider
spider/github
spider/godocorg
store Package store handlings all the storage in GCSE backend.	Package store handlings all the storage in GCSE backend.
utils