diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/LICENSE | 121 | ||||
| -rw-r--r-- | docs/admin_handbook.html | 49 | ||||
| -rw-r--r-- | docs/handbook.css | 17 | ||||
| -rw-r--r-- | iadocs/LICENSE | 4 | ||||
| l---------[-rw-r--r--] | iadocs/cover_page.htm | 353 | ||||
| -rw-r--r-- | iadocs/cover_page.html | 352 |
6 files changed, 544 insertions, 352 deletions
diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/docs/admin_handbook.html b/docs/admin_handbook.html new file mode 100644 index 0000000..e46ea55 --- /dev/null +++ b/docs/admin_handbook.html @@ -0,0 +1,49 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>CCA Admin Handbook</title> + <link rel="stylesheet" href="./handbook.css" /> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + </head> + <body> + <header> + <h1> + CCA Admin Handbook + </h1> + </header> + <main> + <h2>Introduction</h2> + <p> + This handbook guides you in installing, configuring, and managing your CCA Selection System (CCASS) instance. + </p> + <h2>Downloading</h2> + <p> + You may obtain a stable or development version. The stable version is recommended for production. + </p> + <ul> + <li>To obtain a stable version, go to the <a href="https://git.sr.ht/~runxiyu/cca/refs">release page</a> and download the latest version that is not a pre-release.</li> + <li>To obtain an unstable development version, clone the development repository at <a href="https://git.sr.ht/~runxiyu/cca"><code>https://git.sr.ht/~runxiyu/cca</code></a>, or download the latest development snapshot’s tarball at <a href="https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz"><code>https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz</code></a>.</li> + </ul> + <h2>Building</h2> + <p> + There is a top-level <code>Makefile</code> that builds the backend. This is all the compilation necessary at the moment; in the future, the front-end code such as the CSS and JavaScript may be minified too. + </p> + <p> + You may also wish to strip the binary’s debug symbols to shrink the file size: + </p> + <pre>make && strip cca</pre> + <h2>Configuration</h2> + <p> + The <code>static</code> and <code>tmpl</code> directories must be available to the running program, in addition to a configuration file <code>cca.scfg</code>. + </p> + <p> + Copy <a href="./cca.scfg.example">the example configuration file</a> to <code>cca.scfg</code> in the working directory where you intend to run CCASS. Then, edit it, while paying attention to the following: + </p> + <ul> + <li> + </li> + </ul> + </main> + </body> +</html> diff --git a/docs/handbook.css b/docs/handbook.css new file mode 100644 index 0000000..c8b0715 --- /dev/null +++ b/docs/handbook.css @@ -0,0 +1,17 @@ +:root { + --theme: #0062cc; + --anchor-underline-color: lightgray; +} + +html { + font-family: system-ui, sans-serif; + padding: 0rem 10px; + margin: auto; + max-width: 40rem; +} + +a { + color: var(--theme); + text-decoration: underline; + text-decoration-color: var(--anchor-underline-color); +} diff --git a/iadocs/LICENSE b/iadocs/LICENSE new file mode 100644 index 0000000..ad09a38 --- /dev/null +++ b/iadocs/LICENSE @@ -0,0 +1,4 @@ +Copyright (c) 2024 Runxi Yu <https://runxiyu.org> + +Everyone is permitted to copy and distribute verbatim copies +of this IA documentation, but changing it is not allowed. diff --git a/iadocs/cover_page.htm b/iadocs/cover_page.htm index 6bee777..05a7fb8 100644..120000 --- a/iadocs/cover_page.htm +++ b/iadocs/cover_page.htm @@ -1,352 +1 @@ -<!DOCTYPE html> -<!-- - -- Copyright (C) 2024 Runxi Yu <https://runxiyu.org> - -- SPDX-License-Identifier: CC0-1.0 - -- This license header only applies to this cover page. - --> -<!-- - -- This feels like a very wrong way to do multi-line HTML comments - -- Anyways, to anyone reading my actual HTML source: I found the - -- template form to be a bit strange in how it uses tables, and it - -- really doesn't fit into my model of how the web should work. - -- So I took the CSS I use in the actual solution and removed some - -- bits, and there you have it... - --> -<html lang="en"> - <head> - <title>Computer Science Solution Cover Page</title> - <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1" /> -<style> -/* - * General styling for my websites and stuff. - * Well, I guess a reduced version thereof, fit for this cover page. - */ - -:root { - --primary-bg: white; - --primary-fg: black; - --border: #b4b4b4; - --greyedout: #b4b4b4; - --anchor-underline-color: lightgray; - - --theme: #0062cc; - --theme-contrast: #ffffff; - --boxbg: #ebebeb; - --boxfg: #000000; - --rowbg-even: #ffffff; - --rowbg-odd: #f7f7f7; - --danger: #d32535; - --danger-contrast: #ffffff; - --white: #ffffff; - --white-contrast: #222222; -} - -html { - font-family: system-ui, sans-serif; - line-height: 1.2; - border-color: var(--theme); /* FIXME: don't remember why I put this here */ - background-color: var(--primary-bg); - color: var(--primary-fg); -} - -body { - margin: 0; - padding: 0; - min-height: 100vh; -} - -header, main, body > section { - margin: 1rem auto; - padding-left: 1rem; - padding-right: 1rem; - max-width: 60rem; - /* min-height: 100vh; */ -} - -/* - * For accessibility reasons, we still want anchors to be underlined, but - * perhaps not as profound of an underline as the default. - */ -a { - color: var(--theme); - text-decoration: underline; - text-decoration-color: var(--anchor-underline-color); -} - -/* - * The table, the most important element in my site design... - */ -table { - margin-top: 0.4em; - margin-bottom: 0.4em; - border-collapse: collapse; - border: 2px solid var(--border); -} -table.wide { - width: 100%; -} -th[scope~="row"] { - text-align: left; -} -td { - border: 1px solid; - text-align: left; - height: 1.25rem; - border: 1px solid var(--border); - padding: 3px 5px; -} -table.fat td { - padding: 6px 5px; -} -td.th-like, th { - background-color: var(--boxbg) !important; - border: 1px solid var(--border); - font-weight: bold; - padding: 3px 5px; -} -th.min, td.min { - width: 0; - min-width: fit-content; - white-space: nowrap; -} -tr:nth-child(even) td { - background-color: var(--rowbg-even); -} - -tr:nth-child(odd) td { - background-color: var(--rowbg-odd); -} - -/* - * Input elements, which are usually in tables anyway - */ -textarea { - box-sizing: border-box; - background-color: var(--boxbg); - resize: vertical; -} -textarea, input[type=text], input[type=password] { - font-family: sans-serif; - font-size: smaller; - background-color: var(--boxbg); - border: none; - padding: 0.3rem; - width: 100%; - box-sizing: border-box; -} -td.tdinput { - padding: 0rem !important; -} -td.tdinput textarea, td.tdinput input[type=text], td.tdinput input[type=password] { - background-color: transparent !important; -} -th.tdinput { - padding: 0rem !important; -} -th.tdinput textarea, th.tdinput input[type=text], th.tdinput input[type=password] { - background-color: transparent !important; -} - -/* - * Button definitions. - * - * Each button should contain the .btn class and a .btn-type class, where type - * is one of primary, danger, white, and normal. - */ -.btn-primary { - background: var(--theme); - color: var(--theme-contrast); - border: var(--border) 1px solid; - font-weight: bold; -} -.btn-danger { - background: var(--danger); - color: var(--danger-contrast); - border: var(--border) 1px solid; - font-weight: bold; -} -.btn-white { - background: var(--white); - color: var(--white-contrast); - border: var(--border) 1px solid; -} -.btn-normal, input[type=file]::file-selector-button { - background: var(--boxbg); - border: var(--border) 1px solid !important; - color: var(--boxfg); -} -.btn, input[type=submit], input[type=file]::file-selector-button { - display: inline-block; - /* width: 100%; */ - width: auto; - min-width: fit-content; - border-radius: 0; - padding: .1rem .75rem; - font-size: 0.9rem; - transition: background .1s linear; - /* border: none; */ - cursor: pointer; -} -a.btn { - text-decoration: none; -} - - -/* I need to re-learn how flexbox works */ - -/* - * Multiple columns, flexible wrapping - */ -.multicols { - display: flex; - flex-direction: row; - @media(max-width: 50rem) { - flex-wrap: wrap; - gap: 0rem; - } - gap: 2rem; - align-items: stretch; -} - -.multicols div { - min-width: 18em; - /* max-width: 40rem; */ - width: 100%; - margin-left: auto; - margin-right: auto; -} - -/* - * Spanning elements across a flex container with equal space in between - */ -.flex-justify { - display: flex; - justify-content: space-between; - align-items: center; - margin: 0 auto; - border: none; -} - -pre { - background-color: rgb(240, 240, 240); - padding: 0.3rem; - overflow-x: scroll; -} -</style> - </head> - <body> - <header> - <h1>Computer Science Solution Cover Page</h1> - </header> - <main> - <table> - <thead> - <tr> - <th colspan="2"> - Miscellaneous Information - </th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row"> - Solution Title - </th> - <td> - Co-curricular Activity Selection System - </td> - </tr> - <tr> - <th scope="row"> - Candidate Name - </th> - <td> - Runxi Yu - </td> - </tr> - <tr> - <th scope="row"> - School Number - </th> - <td> - 050336 - </td> - </tr> - <tr> - <th scope="row"> - Candidate Session Number - </th> - <td> - XXX - </td> - </tr> - <tr> - <th scope="row"> - Client Name - </th> - <td> - <a href="mailto:ryan.funnell@ykpaoschool.cn"> - Ryan Funnell - </a> - (Head of Co-curricular Activities) - </td> - </tr> - <tr> - <th scope="row"> - Source Repository - </th> - <td> - <a href="https://git.sr.ht/~runxiyu/cca"><code>https://git.sr.ht/~runxiyu/cca</code></a> - </td> - </tr> - <tr> - <th scope="row"> - Ticket Tracker - </th> - <td> - <a href="https://todo.sr.ht/~runxiyu/cca"><code>https://todo.sr.ht/~runxiyu/cca</code></a> - </td> - </tr> - </tbody> - </table> - <h2>Directions to Access Product</h2> - <p> - This solution is intended to be deployed in production at YK Pao School on a virtual machine provisioned by the school’s IT department. Moderating examiners are requested to contact the candidate and the school’s IT department to obtain partial access to the production system through a virtual private network or some other access mechanism. - </p> - <p> - If you are my teacher, you should be able to sign in to the system with your usual Microsoft Entra ID (previously known as Azure Active Directory) credentials. Your account has been granted administrator privileges, with the caveat that everything is read-only to protect the operational security of the production system. - </p> - <p> - A fuller evaluation of the solution may require self-hosting an instance, if the administrative functionality is to be directly assessed. Instructions are available in the <a href="../docs/admin_handbook.html">Admin Handbook</a>, but the process generally just involves compiling the solution, copying the configuration file while making simple changes, and running the service. - </p> - <p> - Users are advised to read the <a href="../docs/user_handbook.html">User Handbook</a>, although the system should be relatively intuitive to most users. - </p> - <p> - An additional <a href="../docs/developer_handbook.html">Developer Handbook</a> is available for future developers who wish to have a more nuanced understanding of the system’s design than what Criterion B requires documenting. - </p> - <h2>Links to Documentation for Assessment Criteria</h2> - <ul> - <li><a href="./crita_planning.pdf">Criterion A: Planning</a></li> - <li><a href="./critb_recordoftasks.pdf">Criterion B: Record of Tasks</a></li> - <li><a href="./critb_design.pdf">Criterion B: Design</a></li> - <li><a href="./critc_development.pdf">Criterion C: Development</a></li> - <li><a href="./critd_functionality.pdf">Criterion D: Functionality</a></li> - <li><a href="./crite_evaluation.pdf">Criterion E: Evaluation</a></li> - <li><a href="./appendix.pdf">Appendix</a></li> - </ul> - <h2>Word Count</h2> - <p> - The word count of IB-required documentation is XXXX words. - </p> - <p> - The handbooks contain additional documentation to assist using the solution in production. Documentation is a critical component of any computer solution. - <strong style="color: red;">Should this count towards the documentation word count? If not, is the examiner allowed to read it? If not, should I create a “concise” version of the handbooks to be used during assessment? If so, where should I put it?</strong> - </p> - <p> - The source code itself is also thoroughly documented in the form of comments, for most non-trivial implementation detail. - </p> - </main> - </body> -</html> +./cover_page.html
\ No newline at end of file diff --git a/iadocs/cover_page.html b/iadocs/cover_page.html new file mode 100644 index 0000000..6bee777 --- /dev/null +++ b/iadocs/cover_page.html @@ -0,0 +1,352 @@ +<!DOCTYPE html> +<!-- + -- Copyright (C) 2024 Runxi Yu <https://runxiyu.org> + -- SPDX-License-Identifier: CC0-1.0 + -- This license header only applies to this cover page. + --> +<!-- + -- This feels like a very wrong way to do multi-line HTML comments + -- Anyways, to anyone reading my actual HTML source: I found the + -- template form to be a bit strange in how it uses tables, and it + -- really doesn't fit into my model of how the web should work. + -- So I took the CSS I use in the actual solution and removed some + -- bits, and there you have it... + --> +<html lang="en"> + <head> + <title>Computer Science Solution Cover Page</title> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> +<style> +/* + * General styling for my websites and stuff. + * Well, I guess a reduced version thereof, fit for this cover page. + */ + +:root { + --primary-bg: white; + --primary-fg: black; + --border: #b4b4b4; + --greyedout: #b4b4b4; + --anchor-underline-color: lightgray; + + --theme: #0062cc; + --theme-contrast: #ffffff; + --boxbg: #ebebeb; + --boxfg: #000000; + --rowbg-even: #ffffff; + --rowbg-odd: #f7f7f7; + --danger: #d32535; + --danger-contrast: #ffffff; + --white: #ffffff; + --white-contrast: #222222; +} + +html { + font-family: system-ui, sans-serif; + line-height: 1.2; + border-color: var(--theme); /* FIXME: don't remember why I put this here */ + background-color: var(--primary-bg); + color: var(--primary-fg); +} + +body { + margin: 0; + padding: 0; + min-height: 100vh; +} + +header, main, body > section { + margin: 1rem auto; + padding-left: 1rem; + padding-right: 1rem; + max-width: 60rem; + /* min-height: 100vh; */ +} + +/* + * For accessibility reasons, we still want anchors to be underlined, but + * perhaps not as profound of an underline as the default. + */ +a { + color: var(--theme); + text-decoration: underline; + text-decoration-color: var(--anchor-underline-color); +} + +/* + * The table, the most important element in my site design... + */ +table { + margin-top: 0.4em; + margin-bottom: 0.4em; + border-collapse: collapse; + border: 2px solid var(--border); +} +table.wide { + width: 100%; +} +th[scope~="row"] { + text-align: left; +} +td { + border: 1px solid; + text-align: left; + height: 1.25rem; + border: 1px solid var(--border); + padding: 3px 5px; +} +table.fat td { + padding: 6px 5px; +} +td.th-like, th { + background-color: var(--boxbg) !important; + border: 1px solid var(--border); + font-weight: bold; + padding: 3px 5px; +} +th.min, td.min { + width: 0; + min-width: fit-content; + white-space: nowrap; +} +tr:nth-child(even) td { + background-color: var(--rowbg-even); +} + +tr:nth-child(odd) td { + background-color: var(--rowbg-odd); +} + +/* + * Input elements, which are usually in tables anyway + */ +textarea { + box-sizing: border-box; + background-color: var(--boxbg); + resize: vertical; +} +textarea, input[type=text], input[type=password] { + font-family: sans-serif; + font-size: smaller; + background-color: var(--boxbg); + border: none; + padding: 0.3rem; + width: 100%; + box-sizing: border-box; +} +td.tdinput { + padding: 0rem !important; +} +td.tdinput textarea, td.tdinput input[type=text], td.tdinput input[type=password] { + background-color: transparent !important; +} +th.tdinput { + padding: 0rem !important; +} +th.tdinput textarea, th.tdinput input[type=text], th.tdinput input[type=password] { + background-color: transparent !important; +} + +/* + * Button definitions. + * + * Each button should contain the .btn class and a .btn-type class, where type + * is one of primary, danger, white, and normal. + */ +.btn-primary { + background: var(--theme); + color: var(--theme-contrast); + border: var(--border) 1px solid; + font-weight: bold; +} +.btn-danger { + background: var(--danger); + color: var(--danger-contrast); + border: var(--border) 1px solid; + font-weight: bold; +} +.btn-white { + background: var(--white); + color: var(--white-contrast); + border: var(--border) 1px solid; +} +.btn-normal, input[type=file]::file-selector-button { + background: var(--boxbg); + border: var(--border) 1px solid !important; + color: var(--boxfg); +} +.btn, input[type=submit], input[type=file]::file-selector-button { + display: inline-block; + /* width: 100%; */ + width: auto; + min-width: fit-content; + border-radius: 0; + padding: .1rem .75rem; + font-size: 0.9rem; + transition: background .1s linear; + /* border: none; */ + cursor: pointer; +} +a.btn { + text-decoration: none; +} + + +/* I need to re-learn how flexbox works */ + +/* + * Multiple columns, flexible wrapping + */ +.multicols { + display: flex; + flex-direction: row; + @media(max-width: 50rem) { + flex-wrap: wrap; + gap: 0rem; + } + gap: 2rem; + align-items: stretch; +} + +.multicols div { + min-width: 18em; + /* max-width: 40rem; */ + width: 100%; + margin-left: auto; + margin-right: auto; +} + +/* + * Spanning elements across a flex container with equal space in between + */ +.flex-justify { + display: flex; + justify-content: space-between; + align-items: center; + margin: 0 auto; + border: none; +} + +pre { + background-color: rgb(240, 240, 240); + padding: 0.3rem; + overflow-x: scroll; +} +</style> + </head> + <body> + <header> + <h1>Computer Science Solution Cover Page</h1> + </header> + <main> + <table> + <thead> + <tr> + <th colspan="2"> + Miscellaneous Information + </th> + </tr> + </thead> + <tbody> + <tr> + <th scope="row"> + Solution Title + </th> + <td> + Co-curricular Activity Selection System + </td> + </tr> + <tr> + <th scope="row"> + Candidate Name + </th> + <td> + Runxi Yu + </td> + </tr> + <tr> + <th scope="row"> + School Number + </th> + <td> + 050336 + </td> + </tr> + <tr> + <th scope="row"> + Candidate Session Number + </th> + <td> + XXX + </td> + </tr> + <tr> + <th scope="row"> + Client Name + </th> + <td> + <a href="mailto:ryan.funnell@ykpaoschool.cn"> + Ryan Funnell + </a> + (Head of Co-curricular Activities) + </td> + </tr> + <tr> + <th scope="row"> + Source Repository + </th> + <td> + <a href="https://git.sr.ht/~runxiyu/cca"><code>https://git.sr.ht/~runxiyu/cca</code></a> + </td> + </tr> + <tr> + <th scope="row"> + Ticket Tracker + </th> + <td> + <a href="https://todo.sr.ht/~runxiyu/cca"><code>https://todo.sr.ht/~runxiyu/cca</code></a> + </td> + </tr> + </tbody> + </table> + <h2>Directions to Access Product</h2> + <p> + This solution is intended to be deployed in production at YK Pao School on a virtual machine provisioned by the school’s IT department. Moderating examiners are requested to contact the candidate and the school’s IT department to obtain partial access to the production system through a virtual private network or some other access mechanism. + </p> + <p> + If you are my teacher, you should be able to sign in to the system with your usual Microsoft Entra ID (previously known as Azure Active Directory) credentials. Your account has been granted administrator privileges, with the caveat that everything is read-only to protect the operational security of the production system. + </p> + <p> + A fuller evaluation of the solution may require self-hosting an instance, if the administrative functionality is to be directly assessed. Instructions are available in the <a href="../docs/admin_handbook.html">Admin Handbook</a>, but the process generally just involves compiling the solution, copying the configuration file while making simple changes, and running the service. + </p> + <p> + Users are advised to read the <a href="../docs/user_handbook.html">User Handbook</a>, although the system should be relatively intuitive to most users. + </p> + <p> + An additional <a href="../docs/developer_handbook.html">Developer Handbook</a> is available for future developers who wish to have a more nuanced understanding of the system’s design than what Criterion B requires documenting. + </p> + <h2>Links to Documentation for Assessment Criteria</h2> + <ul> + <li><a href="./crita_planning.pdf">Criterion A: Planning</a></li> + <li><a href="./critb_recordoftasks.pdf">Criterion B: Record of Tasks</a></li> + <li><a href="./critb_design.pdf">Criterion B: Design</a></li> + <li><a href="./critc_development.pdf">Criterion C: Development</a></li> + <li><a href="./critd_functionality.pdf">Criterion D: Functionality</a></li> + <li><a href="./crite_evaluation.pdf">Criterion E: Evaluation</a></li> + <li><a href="./appendix.pdf">Appendix</a></li> + </ul> + <h2>Word Count</h2> + <p> + The word count of IB-required documentation is XXXX words. + </p> + <p> + The handbooks contain additional documentation to assist using the solution in production. Documentation is a critical component of any computer solution. + <strong style="color: red;">Should this count towards the documentation word count? If not, is the examiner allowed to read it? If not, should I create a “concise” version of the handbooks to be used during assessment? If so, where should I put it?</strong> + </p> + <p> + The source code itself is also thoroughly documented in the form of comments, for most non-trivial implementation detail. + </p> + </main> + </body> +</html> |