README
¶
package adapters
This package contains implementations of the Adapter interface that control different backend applications.
The interface is currently defined as
type Adapter interface {
Command() *exec.Cmd
Start() error
Stop() error
WriteLog(io.Writer)
ServeHTTP(w http.ResponseWriter, r *http.Request)
}
The ServeHTTP function means all adapters implement the http.Handler
interface.
Working implementations
Simple Proxy
A proxy is configured by creating a file in the ~/.zap folder containing the
host/port combination that you want to proxy to. You can specify just a port and
it will assume localhost.
echo "http://127.0.0.1:3000" > ~/.zap/mysite.dev
echo "4000" > ~/.zap/othersite.dev
Elixir/Phoenix
When a mix.exs file is detected in the root of the dir that a symlink points to
and contains the phoenix package then a mix phx.server server will be launched
on a random port and requests will be proxied to that application.
To configure a phoenix application simply create a symbolic link to the
phoenix application and update your config/dev.exs file to allow zap
to override the default 4000 http port.
ln -sf /path/to/phoenix/app ~/.zap/mysite.dev
config/mix.exs
config :your_app, YourApp.Web.Endpoint,
http: [port: System.get_env("PHX_PORT") || 4000],
Static HTML
To enable a static HTML site, simply symlink to a the public directory
where the static files live. Files in the directory will be served, if a directory
root is requested index.html files will be served if they exist.
ln -sf /path/to/static/public ~/.zap/mysite.dev
TODO
- Ruby/Rails
- Ruby/Hanami
- Ruby/Rack
- Ruby/Rakefile
- Docker (Compose)
- Procfile
- Go/Buffalo
- Node/package.json
- PHP
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Adapter ¶
type Adapter interface {
Command() *exec.Cmd
Start() error
Stop() error
WriteLog(io.Writer)
ServeHTTP(w http.ResponseWriter, r *http.Request)
}
Adapter defines the interface for an Adapter implementation
func CreateBuffaloAdapter ¶ added in v0.2.0
CreateBuffaloAdapter creates a new buffalo adapter
func CreatePhoenixAdapter ¶
CreatePhoenixAdapter creates a new phoenix adapter
func CreateProxyAdapter ¶
CreateProxyAdapter creates a new proxy
func CreateRailsAdapter ¶
CreateRailsAdapter creates a new rails adapter
func CreateStaticAdapter ¶
CreateStaticAdapter creates a new static HTML application
type AppProxyAdapter ¶ added in v0.2.0
type AppProxyAdapter struct {
Host string
Dir string
Port string
ShellCommand string
EnvPortName string
RestartPatterns []*regexp.Regexp
// contains filtered or unexported fields
}
AppProxyAdapter holds the state for the application
func (*AppProxyAdapter) Command ¶ added in v0.2.0
func (a *AppProxyAdapter) Command() *exec.Cmd
Command returns the command used to start the application
func (*AppProxyAdapter) ServeHTTP ¶ added in v0.2.0
func (a *AppProxyAdapter) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements the http.Handler interface
func (*AppProxyAdapter) Start ¶ added in v0.2.0
func (a *AppProxyAdapter) Start() error
Start starts the application
func (*AppProxyAdapter) Stop ¶ added in v0.2.0
func (a *AppProxyAdapter) Stop() error
Stop stops the application
func (*AppProxyAdapter) WriteLog ¶ added in v0.2.0
func (a *AppProxyAdapter) WriteLog(w io.Writer)
WriteLog writes the log to the given writer
type ProxyAdapter ¶
ProxyAdapter holds the state for the application
func (*ProxyAdapter) Command ¶
func (d *ProxyAdapter) Command() *exec.Cmd
Command doesn't do anything
func (*ProxyAdapter) ServeHTTP ¶
func (d *ProxyAdapter) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements the http.Handler interface
func (*ProxyAdapter) WriteLog ¶
func (d *ProxyAdapter) WriteLog(w io.Writer)
WriteLog doesn't do anything
type StaticAdapter ¶
type StaticAdapter struct {
Dir string
}
StaticAdapter holds the state for the application
func (*StaticAdapter) Command ¶
func (d *StaticAdapter) Command() *exec.Cmd
Command doesn't do anything
func (*StaticAdapter) ServeHTTP ¶
func (d *StaticAdapter) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements the http.Handler interface
func (*StaticAdapter) WriteLog ¶
func (d *StaticAdapter) WriteLog(w io.Writer)
WriteLog doesn't do anything
Source Files