https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/index.html Stuff related to the on-going task of developing OAT. Hugo en-us https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/wisdom/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/wisdom/index.html This should have been started a LONG time ago… It should have many more pearls. But as they say, The best time to plant a tree is 20 years ago. The next best time is today. Type aliases vs. opaque types You often have some kind of data that has a particular role but a common type, usually String. For example, a Userid. Using a more specific type such as Userid makes code easier to read/understand/maintain. https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/techniques/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/techniques/index.html Techniques strongly tied to OAT. Shorter stuff can go here. Longer or more important stuff may get their own page. Delivering data to the browser When a web page has dynamic data to display, there are several general approaches: Render it all on the server. Ask the server for an updated page when anything changes (Web1.0). Deliver an HTML shell of the page and some ScalaJS. Fetch the data needed from a web service and render it on the browser. https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/updatelocaldb/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://cs.uwaterloo.ca/~cs-oat/devdoc/dev/updatelocaldb/index.html We often connect OAT to a local instance of postgres for testing, etc. Requirements for the local database: Same schema as production. Lots of the same data as production. A much-reduced set of students. Students that are fixed as much as possible (if they change, tests break). Ability to add new students to test time-sensitive features (eg we added degree audit but didn’t have plans defined for the ancient students already in the DB; added some new students). Obfuscate the students so a co-op student can work with them. We periodically extract specific students from the database using code in oat-extractdata. The extracted data is placed in ${OAT_HOME}/oat-testdata. Both of these repositories should be checked out from git.uwaterloo.ca:oat. Their ReadMe documents are helpful.