From f06a83aa1bee96d188b0479a5a82f62b2f2ee821 Mon Sep 17 00:00:00 2001 From: andrewlalis Date: Tue, 31 Dec 2024 07:32:51 -0500 Subject: [PATCH] Improved main readme. --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 6ef3a35..41885dc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # Teacher Tools A collection of simple, easy-to-use utilities for classroom management. + +## Architecture + +This application is built as a Vue3 frontend web application that's served as +static content to the user, and a backend API that's organized into different +"app" namespaces for each separate sub-application provided by this site, +which might categorize this application as a *modular monolith*. + +In the frontend, app-specific content is located under `app/src/apps/`, +and in the backend, you'll find it at `api/source/api_modules/`. + +In addition to specific apps for certain features, authentication is managed +globally for the application. + +## Deploying + +Right now, the application is simply deployed as static web content and a +SystemD service to my DigitalOcean server. Since the API is written in D and +the app is just 100Kib of static content, this app uses almost no resources. + +See the various scripts in this root directory for actions. For most cases, you +can just run `./deploy.sh` to build and deploy the API and app.