aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorivarlovlie <git@ivarlovlie.no>2022-11-11 10:46:38 +0100
committerivarlovlie <git@ivarlovlie.no>2022-11-11 10:46:38 +0100
commitaf99da10360d7a3182df718900c2be9ed10cf831 (patch)
treeee5d820b4275d36293ec5da5336fbf94e5954085
parent7eb575439fb6397d9e9ae9e6d279169aeec8ffb6 (diff)
downloadgreatoffice-af99da10360d7a3182df718900c2be9ed10cf831.tar.xz
greatoffice-af99da10360d7a3182df718900c2be9ed10cf831.zip
fix: rtm
-rw-r--r--README.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/README.md b/README.md
index c6dc21e..67a061f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# Greatoffice
+[TOC]
+
> This codebase and all of its source code is licensed under the GNU General Public License v3.0, see [COPYING](COPYING) for more information.
This repository contains all the code for greatoffice, a business management system.
@@ -46,6 +48,7 @@ All environment variables the api needs to function properly is specified in [`c
#### Minimum required configuration
The following configuration keys need valid values in order to start the api (regardless of environment):
+
* Starting with DB_
* Starting with QUARTZ_DB_
* Equal to APP_CERT
@@ -60,20 +63,22 @@ To run the server in development mode use `dotnet run` (`dotnet watch` for hot-r
To build the server locally use `dotnet build` or `dotnet build -c Release` for production builds.
A helper script is available at [`code/api/build_and_push.sh`](code/api/build_and_push.sh) that handles,
-- Optionally commiting, taging and pushing latest changes to remote git source
-- Building a docker image
-- Pushing the docker image to the default registry at dr.ivar.systems
-- Bumping version number
+
+* Optionally commiting, taging and pushing latest changes to remote git source
+* Building a docker image
+* Pushing the docker image to the default registry at dr.ivar.systems
+* Bumping version number
## code/app
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.
+
+* 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