skygear-server

README

Skygear Server is a cloud backend for your app.

Getting Started

To get started, you need to install Skygear Server and include one of our SDKs into your app. For more information on how to do this, check out the Skygear Server Documentation.

Configuration

Skygear is configure via environment variable. It also support .env file for easy development.

The minimal configuration will be provide API_KEY and MASTER_KEY

$ API_KEY=changeme MASTER_KEY=secret ./skygear-server

Check out .env for configuration reference. Once you configure the .env correctly, you can simple kick start the server by following.

$ ./skygear-server

How to contribute

Dependencies

• Golang 1.5
• PostgreSQL 9.4 with PostGIS extension
• Redis
• libsodium, zeromq and czmq if using ZeroMQ as a plugin transport

If using Mac OS X, you can get ZeroMQ dependencies using Homebrew:

$ brew install libsodium zeromq czmq

Building from source

$ go get github.com/tools/godep
$ godep restore
$ go build  # or `go build --tags zmq` for ZeroMQ support

Testing

1. Create a PostgreSQL database called skygear_test with PostGIS enabled:

psql -h db -c 'CREATE DATABASE skygear_test;' -U postgres
psql -h db -c 'CREATE EXTENSION postgis;' -U postgres -d skygear_test

1. Test case assume the 127.0.0.1 have access to skygear_test, add the following to pg_hba.conf:

host    all             all             127.0.0.1/32            trust

1. Install golang packages required for testing (check .travis.yml for the list).

2. Run go test github.com/skygeario/skygear-server/....