From e10a20de371a6c0de625720585bc16a2219223e0 Mon Sep 17 00:00:00 2001 From: Alasdair Wilson Date: Mon, 15 Jan 2024 16:43:18 +0000 Subject: [PATCH] updated deployment docs for multi repos --- docs/development/index.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/development/index.md b/docs/development/index.md index 63cf3cf..8228763 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -52,6 +52,20 @@ If it is your first time running the application, you will need to run the migra yarn prisma migrate dev ``` +## Providing course material + +Course material is provided by git repositories defined by the "repos" in the [configuration yaml]({{ "/config/template" | relative_url }}). + +Once you have installed the dependencies, you can populate the material directory with: + +```bash +yarn pullmat +``` + +This will pull the course material into the "MATERIAL_DIR" directory, which defaults to `.material`. + +Any course material in this directory will be automatically rendered by gutenberg at `/material`. + ## Running the development server The development server can now be started with: @@ -64,6 +78,15 @@ npm run dev Open [http://localhost:3000](http://localhost:3000) with your browser to see the result! +Alternatively, to test a production build: + +```bash +yarn build +yarn start +``` + +Will build and run a production optimised version of the application. + ## Prisma Studio Prisma Studio is a GUI for viewing and editing the database. It can be started with: