ChrisBoesch / singpathfire

An AngularFire-based version of SingPath
http://chrisboesch.github.io/singpathfire
MIT License
4 stars 7 forks source link

Documentation to support local SingPath development #226

Open SingaporeClouds opened 8 years ago

SingaporeClouds commented 8 years ago

Provide a readme that will explain how to launch a local version of singpathfire on a new firebase url to support local SingPath development. The readme should include all the steps needed to launch a local docker-based verifier that could be used to verify solution submissions.

dinoboff commented 8 years ago

The current way to start the a local verifier is documented on the verifier README:

https://github.com/dinoboff/verifier/blob/master/README.md

There's however no easy way to switch the db the GUI is targeting. The GUI is meant to work without any preprocessing, so It works by default with https://singpath-play.firebaseio.com/. Switching the db to https://singpath.firebaseio.com/ is done by a deployment script.

I could either add a gulp task to switch the server. The user would have to run a preprocessing task for local development.

I could also refactor the GUI to remove all/most built/deployment scripts using SystemJS. It would use SystemJS to loads dependencies, and it leaves a very basic html file:

<!doctype html>
<head>
  <title>Singpath (dev)</title>
</head>
<body>
  <singpath firebase-id="singpath-play"></singpath>

  <script src="vendor/system.js"></script>
  <script src="config.js"></script>
  <script>
    System.import('main.js');
  </script>
</body>

You just need to edit/provide a html file to configure the app (using a directive attribute).