From 63e849c4dbb3e3c8771d14a309edf5083c672f74 Mon Sep 17 00:00:00 2001 From: ivarlovlie Date: Thu, 17 Nov 2022 13:59:59 +0700 Subject: feat: Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d1b2166..6202715 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ Everything is WIP, but the platform is regularly updated at [https://dev.greatof ## code/api -Contains an ASP.NET Core Web API project using the [ApiEndpoints](https://github.com/ardalis/ApiEndpoints) paradigm. +Contains a ASP.NET Core Web API, each route is specified in the Endpoints directory with a single file per route. It handles all data operations (except administrative operations) for the platform. -To run it you need .NET 6 and a PostgreSQL instance. +To run it you need .NET 7 and a PostgreSQL instance. ### Database schemas @@ -72,7 +72,7 @@ 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 a svelte kit application that acts as the frontend for greatoffice. Noteworthy information: @@ -92,4 +92,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 -- cgit v1.3