speakeasy

package module
v0.0.0-...-f358295 Latest Latest
Warning

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

Go to latest
Published: Feb 17, 2022 License: Apache-2.0 Imports: 3 Imported by: 0

README

Intercom

Go Report Card Apache License CircleCI

Speakeasy

A tool for creating web servers that you can embed in iOS or Android apps.

Install

  • Install the speakeasy tool using the following commands:

    go get -d -u github.com/intercom/speakeasy/...
    $GOPATH/src/github.com/intercom/speakeasy/setup.sh
    
Sample Engine
  • From the sample/backend directory run the following commands:

    ./encode-assets.sh
    speakeasy build github.com/intercom/speakeasy/sample/backend
    
Sample app
  • Build the sample engine
  • Open the Android project in sample/android and build it in Android studio
About

This sample uses Twemoji images.

License

Speakeasy is released under the Apache 2.0 license. See LICENSE for details.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Engine

type Engine interface {
	Setup(server *Server)
}

type Server

type Server struct {
	Engine Engine
	Router *mux.Router
}

func NewServer

func NewServer(engine Engine) *Server

func (*Server) Start

func (server *Server) Start()

Directories

Path Synopsis
cmd
sample

Jump to

Keyboard shortcuts

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