From ae4ee26090c87c0d487ba1d558bcffcf4347e77e Mon Sep 17 00:00:00 2001 From: Ava Gaiety W Date: Mon, 4 Mar 2024 17:57:02 +0000 Subject: [PATCH] deploy step, better readme --- README.md | 31 ++++++++++++++++++++++++++++++- package.json | 3 ++- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b86b3a3..ff2295d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ # fursona -Homepage for Gaiety, the doggo \ No newline at end of file +Homepage for Gaiety, the doggo + +## Developing + +In two terminals + +```sh +# first terminal +npm run start + +# second terminal +npm run start:styles +``` + +## Building for production, static site + +```sh +npm run build +``` + +## Deploy steps + +Requires Docker, NodeJS + +_Docker container automatically performs dependency install and build_ + +```sh +npm run deploy +``` + diff --git a/package.json b/package.json index a5a015d..c367f1d 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,8 @@ "build": "eleventy --input=./src --output=./dist", "postbuild": "npx postcss ./src/styles.css -o ./dist/styles.css --env production", "start": "eleventy --serve --input=./src --output=./dist", - "start:styles": "npx postcss ./src/styles.css -o ./dist/styles.css --watch" + "start:styles": "npx postcss ./src/styles.css -o ./dist/styles.css --watch", + "deploy": "docker compose up --build -d" }, "repository": { "type": "git",