summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorivarlovlie <git@ivarlovlie.no>2022-06-01 22:20:39 +0200
committerivarlovlie <git@ivarlovlie.no>2022-06-01 22:20:39 +0200
commitae8899c9beffcfe7d7c6965ddc5df7010ad4006b (patch)
tree37e895b00204787c214ab9fa7d937ebf5ae5d81a
parent9db0f70f75886ab1f97e231a3f9c16fcbbbe04bd (diff)
downloadgreatoffice-ae8899c9beffcfe7d7c6965ddc5df7010ad4006b.tar.xz
greatoffice-ae8899c9beffcfe7d7c6965ddc5df7010ad4006b.zip
docs: Update README
-rw-r--r--README.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/README.md b/README.md
index e17cfb1..f84c4c6 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ This codebase and all of its source code is licensed under the GNU General Publi
Contains an ASP.NET Core Web API project using the [ApiEndpoints](https://github.com/ardalis/ApiEndpoints) paradigm.
-It handles all data operation and administration for the platform.
+It handles all data operations (except administrative operations) for the platform.
To run it you need .NET 6 and a PostgreSQL instance.
@@ -26,7 +26,7 @@ DB_PASSWORD=<password>
DB_NAME=<schema>
```
-### Building/Developing
+### Building and Developing
To run the server in development mode use `dotnet run` (`dotnet watch` for hot-reloading).
@@ -40,17 +40,13 @@ It automatically starts the server and expects the server to host the web-app at
Use `dotnet run` to run the tests.
-## apps/web-app
+## apps/projects
-A svelte project built with vite.
+The projects app is a svelte pwa that handles
-Run the dev task in package.json to open a dev server at localhost:3xxx (usually :3000). Append `--host` as a parameter to this task if you need to expose the app on your local
-network.
-
-Contains the public sites (in `apps/web-app/_public`) which include login, signup and password resetting etc. and the meat of the application as a nested application (meaning it is
-not loaded unless you are logged in)
-in `apps/web-app/app`.
+- project management
+- time tracking
## apps/web-shared
-A source lib containing models, shared styles and shared components for all of great office's js clients.
+A source lib containing models, shared styles and shared components for all of great office's js clients/apps.