From da981411609e3d2cbd269ccae228fb9740970c5f Mon Sep 17 00:00:00 2001 From: LMBishop <13875753+LMBishop@users.noreply.github.com> Date: Mon, 20 Dec 2021 15:20:12 +0000 Subject: Update README --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d787f3..cd4ed5e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,22 @@ # Website This repository hosts the source code which (eventually) powers my website: https://leonardobishop.com/ -The web app runs on NodeJS using [Express](https://www.npmjs.com/package/express) and renders web pages with [ejs](https://www.npmjs.com/package/ejs). It parses content pages written in a markup language (currently [Wikitext](https://en.wikipedia.org/wiki/Help:Wikitext)) from the `pages/` directory and renders them as HTML. +The app is written in TypeScript and runs on NodeJS using [Express](https://www.npmjs.com/package/express), rendering web pages with [ejs](https://www.npmjs.com/package/ejs). It parses content pages written in a markup language (currently [Wikitext](https://en.wikipedia.org/wiki/Help:Wikitext)) from the `pages/` directory and renders them as HTML. -## Building +## Building and running Instructions to build and deploy the web app will be written here whenever it is finished. + +### Using docker +``` +$ docker build -t website . +$ docker run -p 3000:3000 website +``` + +### Building directly +``` +$ npm i -g typescript +$ npm ci --only-production +$ tsc && node build/index.js +``` + +The application will be listening on port 3000. -- cgit v1.2.3-70-g09d2