Merge pull request #83 from RSE-Sheffield/feat/survey-ui

feat: Survey UI

.gitignore

@@ -11,7 +11,7 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
+/lib/
 lib64/
 parts/
 sdist/

assets/sort-survey-configurator/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

assets/sort-survey-configurator/README.md

@@ -0,0 +1,81 @@
+# SORT Survey Widgets
+
+UI Widgets for configuring SORT forms
+
+## Dependencies
+
+- nodejs (20.x)
+- vite
+- svelte
+
+## Overview
+TBC
+
+## Installation
+
+First install [nodejs](https://nodejs.org/en) on your machine. For linux I've found [nvm](https://github.com/nvm-sh/nvm)
+is good as it allows you to install multiple versions of node and select between them.
+
+Navigate to the folder `/assets/sort-survey-configurator`.
+
+Install dependencies using `npm install`
+
+
+## Previewing the components live
+
+To preview the components (separate from the website) run the following command:
+
+```
+npm run dev
+```
+
+This will start a local dev server where the component can be previewed.
+
+
+## Building the components
+
+Build by running:
+
+```
+npm run build
+```
+
+This will build the widgets into the `/static/js/sort-ui` folder which can then be imported by the django templates.
+
+
+## Technical considerations ()
+Instructions below came pre-generated, leaving this here for now in case it's useful:
+
+**Why use this over SvelteKit?**
+
+- It brings its own routing solution which might not be preferable for some users.
+- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
+
+This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
+
+Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
+
+**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
+
+Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
+
+**Why include `.vscode/extensions.json`?**
+
+Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
+
+**Why enable `allowJs` in the TS template?**
+
+While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
+
+**Why is HMR not preserving my local component state?**
+
+HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
+
+If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
+
+```ts
+// store.ts
+// An extremely simple external store
+import { writable } from 'svelte/store'
+export default writable(0)
+```

assets/sort-survey-configurator/index.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css"
+              rel="stylesheet">
+    <link href="https://cdn.jsdelivr.net/npm/[email protected]/css/boxicons.min.css"
+              rel="stylesheet">
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>SORT Survey Configurator harness</title>
+
+  </head>
+  <body>
+    <div id="app"></div>
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"></script>
+    <script type="module"  src="/src/main.ts" ></script>
+  </body>
+</html>