README.md

Form API

Data Collector as a Service.

Quick start

$ make deps up && make demo && make status

     Name                    Command               State                Ports             
------------------------------------------------------------------------------------------
env_db_1          docker-entrypoint.sh postgres    Up       0.0.0.0:5432->5432/tcp        
env_migration_1   form-api migrate up              Exit 0                                 
env_server_1      /bin/sh -c envsubst '$SERV ...   Up       80/tcp, 0.0.0.0:8080->8080/tcp
env_service_1     form-api run --with-profiler     Up       0.0.0.0:8081->8080/tcp        

$ curl http://localhost:8080/api/v1/41ca5e09-3ce2-4094-b108-3ecc257c6fa4
$ curl -H "Content-Type: application/x-www-form-urlencoded" \
       --data-urlencode "email=test@my.email" \
       http://localhost:8080/api/v1/41ca5e09-3ce2-4094-b108-3ecc257c6fa4

Specification

API

You can find API specification here. Also, we recommend using Insomnia HTTP client to work with the API - you can import data for it from the file.

CLI

$ form-api --help
Form API

Usage:
   [command]

Available Commands:
  help        Help about any command
  migrate     Apply database migration
  run         Start HTTP server
  version     Show application version

Flags:
  -h, --help   help for this command

Installation

Brew

$ brew install kamilsk/tap/form-api

Binary

$ export FAPI_V=1.0.5   # all available versions are on https://github.com/kamilsk/form-api/releases
$ export REQ_OS=Linux   # macOS and Windows are also available
$ export REQ_ARCH=64bit # 32bit is also available
$ wget -q -O form-api.tar.gz \
       https://github.com/kamilsk/form-api/releases/download/${FAPI_V}/form-api_${FAPI_V}_${REQ_OS}-${REQ_ARCH}.tar.gz
$ tar xf form-api.tar.gz -C "${GOPATH}"/bin/
$ rm form-api.tar.gz

Docker Hub

$ docker pull kamilsk/form-api:latest

From source code

$ go get -d -u github.com/kamilsk/form-api
$ cd ${GOPATH}/src/github.com/kamilsk/form-api
$ make deps generate test install

Mirror

$ egg bitbucket.org/kamilsk/form-api

egg is an extended go get.

Requirements

• Docker 17.09.0-ce or above
• Docker Compose 1.16.1 or above
• Go 1.9.2 or above
• GNU Make 3.81 or above

Feedback

Notes

• brief roadmap
  • v1: MVP
  • v2: CRUD
  • v3: GUI
  • v4: API v2
  • v5: Extensibility
  • FormA, SaaS
• tested on Go 1.9 and 1.10
• made with ❤️ by OctoLab