OwlBoard
/
owlboard-svelte
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
A new OwlBoard frontend developed with Svelte
181 Commits 1 Branch 3 Tags 12 MiB
Svelte 88.1%
TypeScript 8%
CSS 2.2%
JavaScript 1.5%
HTML 0.2%
Go to file
Fred Boniface 23d75880b5 format files 2024-01-16 20:34:41 +00:00
src format files 2024-01-16 20:34:41 +00:00
static Add PWA Shortcuts and associated icons 2023-10-16 12:32:04 +01:00
.eslintignore Initiate Svelte 2023-06-12 19:02:49 +01:00
.eslintrc.cjs Closes issue: OwlBoard/backend#39 2023-08-24 20:24:28 +01:00
.gitignore Initiate Svelte 2023-06-12 19:02:49 +01:00
.npmrc Prepare to re-write table-generator for new TS-Type API 2023-08-05 01:02:42 +01:00
.prettierignore Initiate Svelte 2023-06-12 19:02:49 +01:00
.prettierrc Reformat 2023-07-07 11:29:33 +01:00
LICENSE Initial commit 2023-06-12 09:06:19 +01:00
README.md Closes issue: OwlBoard/backend#39 2023-08-24 20:24:28 +01:00
dockerfile Adjust version and ensure .npmrc is included in Docker build step 2023-08-07 11:04:39 +01:00
nginx.conf StaffLDB-Minify (#1) 2023-10-03 21:36:58 +01:00
package-lock.json format files 2024-01-16 20:34:41 +00:00
package.json Bump @owlboard/ts-types version 2023-11-30 09:17:48 +00:00
svelte.config.js Closes issue: OwlBoard/backend#39 2023-08-24 20:24:28 +01:00
tsconfig.json Closes issue: OwlBoard/backend#39 2023-08-24 20:24:28 +01:00
vite.config.ts Update config files to TS 2023-07-24 11:05:08 +01:00

README.md

owlboard-svelte

owlboard-svelte is the OwlBoard web-frontend as of version 2023.7.1 replacing the previous version (https://git.fjla.uk/owlboard/web) and moving from a raw HTML/CSS/JS to a statically build Svelte website.

The decision was made because as new features were added, the markup and code started to become difficult to manage and maintain. The Svelte version introduces reusable components simplifying the maintenance and the addition of new features.

Building

To build owlboard-svelte, simply clone the repo and run npm run build which will build a static website in the build folder. The static files can then be uplaoded to a webserver of your choice.

The website is build statically for server performance reasons - running an nginx server is lighter than running Node considering that much of the data fetching and processing happens on the client side anyway due to user UUID access keys being required.

TypeScript

Any new code added to the website should be written in TypeScript - where Javascript is extended, it should be re-written into TypeScript.