From aa97cc4d8c0cf719a7e95fd5bb4daa810a2537db Mon Sep 17 00:00:00 2001 From: Admin Date: Wed, 3 May 2023 18:33:59 -0400 Subject: [PATCH] Add README --- web/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 web/README.md diff --git a/web/README.md b/web/README.md new file mode 100644 index 0000000..c080ece --- /dev/null +++ b/web/README.md @@ -0,0 +1,33 @@ +# BW Contest Web + +## Build Instructions + +### For all builds + +You must fill out a `.env` file. An example is provided in `.env.example`. This is used for dev, production, and docker. + +Build dependencies: + +- NodeJS +- Docker (for docker build) + +### For Development + +```console +$ npm install +$ npm run dev +``` + +### For Production + +```console +$ npm install +$ npm run build +$ node build +``` + +### Docker + +```console +$ docker-compose up --build +```