# gcse

**Repository Path**: mirrors_danielqsj/gcse

## Basic Information

- **Project Name**: gcse
- **Description**: Project for Go Search, a search engine for finding popular and relevant packages.
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Go Search
=========

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

Online service: [Go Search](http://go-search.org/)

This is the root package with shared functions.

Sub packages are commands for running:

* [HTTP Server](http://github.com/daviddengcn/gcse/server): Searching and web service
* [ToCrawl](http://github.com/daviddengcn/gcse/tocrawl): Find packages to crawl.
* [Crawler](http://github.com/daviddengcn/gcse/crawler): Crawling package files.
* [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.