appix

README

Travix Fireball ADK

App Developer Kit for the Travix Fireball infrastructure. The ADK consists of appix, a CLI tool to publish Apps to the App Catalog.

Installation

The ADK can be used on either Windows, Linux and Mac. There are separate installation scripts for Windows and Linux/Mac.

Windows

To install the latest version on Windows, execute the following command in a PowerShell window.

iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/Travix-International/appix/master/appixinstall.ps1'))

To install a specific version of the ADK, set the APPIX_VERSION environment variable before executing the above script.

$env:APPIX_VERSION='1.0.0.5'
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/Travix-International/appix/master/appixinstall.ps1'))

Linux and macOS

To install the latest version, run the following command in a terminal.

$ curl -sSL https://raw.githubusercontent.com/Travix-International/appix/master/appixinstall.sh | sh

To install a specific version of the ADK, run the following command.

$ curl -sSL https://raw.githubusercontent.com/Travix-International/appix/master/appixinstall.sh | APPIX_VERSION=1.0.0.5 sh

Getting started

After installation, the ADK can be run by typing appix in the terminal. Run appix --help to view the available commands and usage.

Development

For developing the ADK itself:

Clone

Clone the repo to your $GOPATH:

$ git clone git@github.com:Travix-International/appix.git $GOPATH/src/github.com/Travix-International/appix

Dependencies

Install the dependencies with gvt:

$ cd $GOPATH/src/github.com/Travix-International/appix
$ gvt restore

Environment variables

Make sure you have these environment variables (usually in your ~/.bash_profile file) with the correct values:

export TRAVIX_FIREBASE_API_KEY=""
export TRAVIX_FIREBASE_AUTH_DOMAIN=""
export TRAVIX_FIREBASE_DATABASE_URL=""
export TRAVIX_FIREBASE_STORAGE_BUCKET=""
export TRAVIX_FIREBASE_MESSAGING_SENDER_ID=""
export TRAVIX_LOGGER_URL=""
export TRAVIX_FIREBASE_REFRESH_TOKEN_URL=""
export TRAVIX_CERT_CONTENT=""
export TRAVIX_KEY_CONTENT=""
export TRAVIX_DEVELOPER_PROFILE_URL=""

Using a custom dev server

If we want to override the dev server to which appix is pushing an application under development, we have to add the "DevServerOverride" property to the .appixDevSettings file in the root folder of our application.

{
  ...
  "DevServerOverride": "https://my-dev-server.example.com"
}

Build

Running this would generate ./bin/appix-mac (if you are on macOS):

$ ./build.sh

Furthermore, you can copy it to the local appix path for easy access:

$ cp ./bin/appix-mac ~/.appix/appix

Now you can execute it as $ appix as usual.

License

MIT @ Travix International

Documentation

Index

• func IgnoreFilePath(path string) (ignored bool)
• func RegisterInit(app *kingpin.Application, config config.Config, args *GlobalArgs)
• func RegisterLogin(app *kingpin.Application, config config.Config, args *GlobalArgs)
• func RegisterPush(app *kingpin.Application, config config.Config, args *GlobalArgs, ...)
• func RegisterSubmit(app *kingpin.Application, config config.Config, args *GlobalArgs, ...)
• func RegisterVersion(app *kingpin.Application, config config.Config)
• func RegisterWatch(app *kingpin.Application, config config.Config, args *GlobalArgs, ...)
• func RegisterWhoami(app *kingpin.Application, config config.Config, args *GlobalArgs, ...)
• func ReplaceInFile(file, from, to string) error
• type DevelopmentSettings
• type GlobalArgs

Functions

func IgnoreFilePath

func IgnoreFilePath(path string) (ignored bool)

func RegisterInit

func RegisterInit(app *kingpin.Application, config config.Config, args *GlobalArgs)

RegisterInit registers the 'init' command.

func RegisterLogin

func RegisterLogin(app *kingpin.Application, config config.Config, args *GlobalArgs)

RegisterLogin registers the 'login' command.

func RegisterPush

func RegisterPush(app *kingpin.Application, config config.Config, args *GlobalArgs, logger *appixLogger.Logger)

RegisterPush registers the 'push' command.

func RegisterSubmit

func RegisterSubmit(app *kingpin.Application, config config.Config, args *GlobalArgs, logger *appixLogger.Logger)

RegisterSubmit registers the 'submit' command.

func RegisterVersion

func RegisterVersion(app *kingpin.Application, config config.Config)

RegisterVersion registers the 'version' command.

func RegisterWatch

func RegisterWatch(app *kingpin.Application, config config.Config, args *GlobalArgs, logger *appixLogger.Logger)

RegisterWatch registers the 'watch' command.

func RegisterWhoami

func RegisterWhoami(app *kingpin.Application, config config.Config, args *GlobalArgs, logger *appixLogger.Logger)

RegisterWhoami registers the 'whoami' command.

func ReplaceInFile

func ReplaceInFile(file, from, to string) error

Types

type DevelopmentSettings

type DevelopmentSettings struct {
	SessionID         string // This would be the session ID that the user will use the push/preview his changes.
	DevServerOverride string // When pushing an app, the default dev server returned by the app catalog can be overwritten with this.
}

type GlobalArgs

type GlobalArgs struct {
	Verbose   bool
	TargetEnv string
}

GlobalArgs defines the basic set of arguments which can be used by all verbs.