32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
# Clearity
|
|
|
|
Clearity is a workspace management system offering a comprehensive multi-occupancy management solution for office, lab and workspace portfolio management, and billing in a single, centralised platform.
|
|
|
|
This project is based inspired by Clarity Core by RA, for which more information can be found on their website here: https://ra-is.co.uk/clarity-core-workspace-management-system/. However, that application is based on an outdated architecture.
|
|
|
|
This application has not yet been deployed to production so feel free to make drastic changes.
|
|
|
|
## Tech Stack
|
|
|
|
- Svelte
|
|
- SvelteKit
|
|
- Drizzle w/ libSQL
|
|
- Zod for validation
|
|
- [better-auth for authenticaton](https://better-auth.com/docs/introduction)
|
|
- [shadcn-svelte for UI components](https://www.shadcn-svelte.com/docs)
|
|
- [runed for helper functions](https://runed.dev/docs) (e.g. useUrlSearchParams)
|
|
|
|
## Deployment
|
|
|
|
Target for deployment is Cloudflare using wrangler.jsonc and the wrangler cli.
|
|
|
|
- Cloudflare Workers
|
|
- Cloudflare D1
|
|
- Cloudflare R2
|
|
|
|
## Semantics
|
|
|
|
Break large +page.svelte files into several constituent-component-files.svelte using kebab case naming conventions and stored in the same directory as the +page.svelte file unless it's used across several pages.
|
|
|
|
Keep abstractions as mimimal as possible to help ensure this project is human-readable.
|