ellelament / couserver Goto Github PK

#Children of Ur Web Server#

##What is this?## This repository contains the source code for Children of Ur's Dart-based application server. The project is currently hosted at childrenofur.com.

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.

##Getting Started##

1. Download the Dart Editor
2. In the Dart Editor, go to File -> "Open Existing Folder" and open this project folder
3. 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.

##Running##

1. To run the server, you will have to create an 'API_KEYS.dart' file in the lib directory. Directions can be found in the developer docs here.
2. After that, right-click on the declarations.dart file and select Run to start the server on your local machine.
3. Go to http://localhost:8181/serverStatus to test that your server is returning data. See server.dart for other routes.