gosf-sample-app

An example GOSF (GoLang SocketIO Framework) based API server. It's a great starter application for building your own SocketIO API server in GoLang.

This example SocketIO API server was written using GOSF. Learn more about GOSF, the GoLang SocketIO Framework at github.com/ambelovsky/gosf.

Get It

Fork it or download the site as a zip file.

Installation

. ./scripts/getdeps.sh

Launch

. ./scripts/run.sh

File Structure

 scripts
 -- setpath.sh
 -- getdeps.sh
 -- build.sh
 -- run.sh

Scripts are fairly self-explanatory, but they only work on *nix OS's.

setpath.sh will do its best to set default GOPATH information.
getdeps.sh stores all known package dependencies and will make fetching them easy.
build.sh calls both setpath.sh and getdeps.sh before attempting to build a binary and copy config files.
run.sh calls build.sh and runs the resulting application.

 config
 -- server.json
 -- server-secure.json

Configuration files get copied to the output directory with the binary during the build process.

server.json can be referenced inside your application if you only need a standard socket server
server-secure.json can be referenced inside your application if you need a secure socket server

Config files are loaded in main.go. Be sure to double-check the content of the config files to adjust settings.

 src
 -- app
 ----- main.go
 ----- plugins.go
 ----- routes.go
 ----- controller-*.go

The app directory contains all of your application files. This is where you'll do most of your development.

main.go configures and starts the server
plugins.go is responsible for loading plugin packages
routes.go connects socket.io endpoints to controllers
controller-*.go contain methods that are called by connected clients based on the endpoint configuration in routes.go

scaffolding.html

This scaffolding file is extremely helpful for testing your endpoints as you build them. It is already preloaded with some sample fields including working calls to "auth.register" and "util.echo".