From d4330b0c7f5a92380f10a0e3682b21210bede67c Mon Sep 17 00:00:00 2001 From: ivarlovlie Date: Fri, 11 Nov 2022 16:37:59 +0700 Subject: feat: Update README.md --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e5a0f67..af8661d 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ I recommend using a seperate database for the quartz schema and app schema, sinc The api uses Hashicorp's vault to manage it's configuration, environment variables is used to point the api in the direction of the vault json object that contains the configuration. -The configuration is described by [code/api/src/Data/Models/AppConfiguration.cs](./code/api/src/Data/Models/AppConfiguration.cs). +The configuration is described by [`code/api/src/Data/Models/AppConfiguration.cs`](./code/api/src/Data/Models/AppConfiguration.cs). I recommend using [user-secrets](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets) to set environment variables when developing. -All environment variables the api needs to function properly is specified in [code/api/src/Data/Static/AppEnvironmentVariables.cs](./code/api/src/Data/Static/AppEnvironmentVariables.cs). +All environment variables the api needs to function properly is specified in [`code/api/src/Data/Static/AppEnvironmentVariables.cs`](./code/api/src/Data/Static/AppEnvironmentVariables.cs). #### Minimum required configuration @@ -67,11 +67,18 @@ A helper script is available at [`code/api/build_and_push.sh`](code/api/build_an ## code/app -Contains an svelte kit application that acts as the frontend for greatoffice +Contains an svelte kit application that acts as the frontend for greatoffice. + +Noteworthy information: +- The ui consists largely of components from or inspired by tailwind ui. +- When you run the frontend in dev mode, most of the available components is showcased standalone at `/book`. +- The app uses [temporal-polyfill](https://github.com/fullcalendar/temporal) to do date and time operations, docs is [here](https://tc39.es/proposal-temporal/docs/#api-documentation) (excited to see this api implemented natively soon). +- Svelte headless ui is used for some of the components, while the library is great it unfortunately seems to be unmaintained and therefore i forked it into `@developermuch/dev-svelte-headlessui` where i publish additions from upstream. This package can hopefully be deprecated in the future. ### Environment The app reads environment variables from [`code/app/.env`](code/app/.env-example), keys need to start with `VITE_`. +> The `.env` file is ignore by default, so you should copy `.env-example` into your own `.env`. ### Building and Developing @@ -79,4 +86,4 @@ To run the app in development mode use `pnpm run dev`. To build a production build use `pnpm run build`, the production build is placed in the `build` folder. -> Use `node build/index.js` (minimum v16) to run the app \ No newline at end of file +> Use `node build/index.js` (minimum v16) to run the app \ No newline at end of file -- cgit v1.3