kimitzu-services

command module
v0.2.0-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 18, 2020 License: MPL-2.0 Imports: 16 Imported by: 0

README

Kimitzu Services

This repository contains the API layer used by the Kimitzu Client.

Features

  • Voyager Crawler Service
    • Indexing
    • Caching
  • Search Service
    • Keyword Search
    • Advanced Filtering
      • By Listing
      • By Profile
    • Location Service
      • Distance within radius of (lat, lng)
      • Zip Code
  • S/Kademlia P2P Service for Decentralized Ratings
    • P2P rendezvous via S/Kademlia DHT network

Documentation

API documentation can be found in Postman API Docs.

(Documentation in progress.)

Prerequisites

  • Go Version 1.12 or higher
  • Packr2: go get -u github.com/gobuffalo/packr/v2/packr2

Building

go get -u -v github.com/kimitzu-foundation/kimitzu-services
packr2
go build services.go

Packr2 is used to package some external dependencies (location maps) for a single and compact build file.

Run

For Windows

./services.exe

To enable logging (loglevels 1 to 5)

./services.exe --log <logLevel>

For Unix Systems

./services

To enable logging (loglevels 1 to 5)

./services --log <logLevel>

License

MPL-2.0.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL