Configuring the editor
Editor config settings control how the Buggy Editor (which is the webapp that each student develops) is managed.
The EDITOR_DISTRIBUTION_METHOD
setting is critical to how your students start your project: see more details about distributing the code.
Config settings (“Editor”)
Setting | Description |
---|---|
EDITOR_DOWNLOAD_URL | If you are not using a VCS platform like GitHub or GitLab (IS_USING_VCS is No ), your students can download the buggy editor zipfile directly from this server. If you prefer to provide your own copy instead, provide a URL to your own instructions or zipfile instead. This setting is ignored if IS_USING_VCS is Yes . Default value: none/empty |
EDITOR_ZIPFILE_NAME | If you are not using a VCS platform like Github or GitLab (IS_USING_VCS is No ), and want to use the default buggy editor source code served from this server, what should the zip file that students download be called? Default value: buggy-race-editor.zip |
EDITOR_HOST | The default host that the students’ buggy editors use. Make sure this matches the host argument that the editor app is launched with (at the bottom of the editor app.py ). This may appear in the task and tech notes, and (if you’re distributing the editor source code via static zip file from this server) will be written into the app.py file too. Default value: 0.0.0.0 |
EDITOR_PORT | The default port that the students’ buggy editors use. Make sure this matches the port argument that the editor app is launched with (at the bottom of the editor app.py ). This may appear in the task and tech notes, and (if you’re distributing the editor source code via static zip file from this server) will be written into the app.py file too. Default value: 5000 |
IS_WRITING_HOST_AND_PORT_IN_EDITOR | If you publish the buggy editor app on this server, should the EDITOR_HOST and EDITOR_PORT values be written into app.py ? This setting won’t be used if you don’t generate the zipfile on this server (for example, if IS_USING_VCS is Yes ). Default value: Yes |
IS_WRITING_SERVER_URL_IN_EDITOR | If you publish the buggy editor app on this server, should the BUGGY_RACE_SERVER_URL be written into app.py ? This setting won’t be used if you don’t generate the zipfile on this server (for example, if IS_USING_VCS is Yes ) but remember you or your students do need to change it inside the buggy editor source code eventually. Default value: Yes |
- Previous: Project config
- Next: Tasks config