authServer

Children of Ur's Dart-based login and authentication server

This repository contains the source code for Children of Ur's Dart-based web server. It was split off from the main CoU server for reasons of stability and separation of tasks.

License

Children of Ur is based on Tiny Speck's browser-based game, Glitch™. The original game's elements have been released into the public domain. For more information on the original game and its licensing information, visit glitchthegame.com.

License information for other assets used in Children of Ur can be found in ATTRIBUTION.md.

Usage

The code is live at childrenofur.com.

If you want to run it locally or on your own server, you'll need to have an environment with Dart installed. Note that this repository does not currently contain any prebuilt files, so you'll also need a development environment. See Contributing below.

Contributing

authServer is based on Dart, so the first thing you'll need to do (if you haven't already) is to install it.

Setting up a development environment

Mac OS X / macOS via homebrew

1. brew update
2. brew tap dart-lang/dart
3. brew install dart --with-content-shell --with-dartium

Windows

1. Download the Dart Editor.

Building

In Dart Editor

1. Go to File -> "Open Existing Folder" and open this project folder.
2. Make sure you have the required dependencies specified in pubspec.yaml. If you're missing any of these, try selecting a file in the project, and then running Tools -> Pub Get.

Command line

1. pub get
2. pub build

Running local

The server requires some configuration to be able to attach to external services in a file named API_KEYS.dart. There's a non-working example in the root directory named API_KEYS.dart.example. Contact one of the development team for working values.

In Dart Editor

1. Right-click on bin/authserver.dart and select Run.

If you do not have a signed cert and cert password, you will have to supply the --no-load-cert option in the Dart Editor run configuration.

Command line

dart bin/authserver.dart

If you do not have a signed cert and cert password, you will have to add the --no-load-cert option:

dart bin/authserver.dart --no-load-cert

But is it really running?

Load http://localhost:8383/serverStatus in a browser or using curl and you should see output like

{"status":"OK","loadCert":false}

Testing

To run the tests, you can either type dart test/all_tests.dart from the command line, or right-click on test/all_tests.dart and select 'Run' in the Dart Editor.