skygear-server

README

Skygear Server is a cloud backend for making web and mobile app development easier. https://skygear.io

Getting Started

To get started, you need to install Skygear Server and include one of the SDKs into your app. You can see detailed procedure at the getting started guide at https://docs.skygear.io/server/guide.

The fastest way to get Skygear Server running is to download the runnable binaries of the latest release at https://github.com/SkygearIO/skygear-server/releases

You can also sign up the Skygear Hosting at the Skygear Developer Portal at https://portal.skygear.io

Connect your app to Skygear Server

Skygear provides SDKs for all the major platforms. Please refer to the guide for each platform to learn how to connect your app to Skygear Server: [iOS] (https://docs.skygear.io/ios/guide) / Android / JavaScript

Documentation

The full documentation for Skygear Server is available on our docs site. The Skygear Server guide is a good place to get started.

Can I Access The Docs Offline?

The documentation repository is public and all the content files are in markdown. If you'd like to keep a copy locally, please do!

Support

For implementation related questions or technical support, please refer to the Stack Overflow community.

If you believe you've found an issue with Skygear Server, please feel free to report an issue.

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

Pull Requests Welcome!

We really want to see Skygear grows and thrives in the open source community. If you have any fixes or suggestions, simply send us a pull request!

Dependencies

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

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

$ brew install libsodium zeromq czmq

Building from source

$ go get github.com/Masterminds/glide
$ make vendor
$ # export WITH_ZMQ=1 # If you need ZeroMQ support
$ make build

Building with Nix

Assuming you have Nix installed, Skygear can be built with the following command:

nix-build default.nix

You will have a symbolic link result-bin linking to the binary.

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
psql -h db -c 'CREATE EXTENSION citext;' -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/pkg/....

You can also run the test suite in Docker:

$ make vendor WITH_DOCKER=1  # install dependencies
$ make before-docker-test    # start dependent services
$ make test WITH_DOCKER=1    # run test
$ make after-docker-test     # clean up docker containers

License & Copyright

Copyright (c) 2015-present, Oursky Ltd.
All rights reserved.

This source code is licensed under the Apache License version 2.0
found in the LICENSE file in the root directory of this source tree.
An additional grant of patent rights can be found in the PATENTS
file in the same directory.