The Buggy Editor zipfile

The buggy editor zipfile contains the source code for the Buggy Editor application that each student works on and develops.

You only need this if you have chosen to distribute the source to the students on the race server (this is “method zip” — which is the simplest method you can choose, and also the default).

For example, if you’re distributing the code via GitHub, you do not need to publish the zipfile.

Publishing the zipfile on the race server

Admin → Config → Buggy editor → Publish editor zipfile

This is the default behaviour: you customise the README, and add the URL for this race server to the Python (app.py) when you publish the zipfile. The race server will suggest the customised README for you — the text it invites you to submit already uses some of your config settings.

If you choose not to publish the zipfile (because you’re using a different distribution method), there are instructions on customising the buggy editor manually.

If you don’t publish the zipfile — 404!

If you are using the default set-up, with the buggy editor being served by the race server, but you don’t publish them — or your hosting platform (e.g., Heroku) does not preserve them when you redeploy the software — the students will get 404 errors when they follow links to download it. You must re-publish the zipfile manually. The admin dashboard and set-up summary both show warnings if the zipfile is missing.