README.md

A Trie System

This repository contains

• A unicode-safe implementation of the trie data structure

• A concurrent API server (see docs/SERVER.md)

• A CLI to access the API (see docs/CLI.md)

• Unit tests that are automatically run by Travis CI (see docs/TESTING.md)

Repository structure

• tries/: Go subpackage that implements the trie data structure

  • Source code in files called <name>.go

  • Unit tests in files called <name>_test.go

• cli/trie/: Go subpackage that implements the CLI

• docs/: Documentation folder

  • Server README

  • CLI README

  • Testing README

• server.go: Server source code

• server_test.go: Local server tests

• *.sh: Convenience scripts

  • deploy.sh: Deploy changes to Google Cloud

  • run.sh: Get an instance of the API running locally

  • test.sh: Run all unit tests