diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9cc16e --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# BW High School Programming Contest Environment + +This is a mono-repo comprised of 3 components: `web`, `sandbox`, and `extension`. + +Each directory contains instructions for building, development, and deployment. diff --git a/extension/README.md b/extension/README.md new file mode 100644 index 0000000..7387c2d --- /dev/null +++ b/extension/README.md @@ -0,0 +1,23 @@ +# BW Contest VSCode extension + +## Build Instructions + +### For Development + +```bash +npm i +npm run compile +npm run watch +``` + +You must be using VSCode, then press `F5` to debug the extension + +### For Production + +```bash +npm i +npm run vscode:prepublish +npx vsce package +``` + +This should then create a `.vsix` file that can be installed to any VSCode editor. diff --git a/sandbox/README.md b/sandbox/README.md new file mode 100644 index 0000000..db1695f --- /dev/null +++ b/sandbox/README.md @@ -0,0 +1,36 @@ +# BW Contest Sandbox + +## 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) + +It is recommended to test development changes in a docker container. + +### For Development + +```bash +npm i +npm run build +node build +``` + +### For Production + +```bash +npm i +npm run build +node build +``` + +### Docker + +```bash +docker compose up --build +``` diff --git a/web/README.md b/web/README.md index c080ece..c79b776 100644 --- a/web/README.md +++ b/web/README.md @@ -13,21 +13,21 @@ Build dependencies: ### For Development -```console -$ npm install -$ npm run dev +```bash +npm i +npm run dev ``` ### For Production -```console -$ npm install -$ npm run build -$ node build +```bash +npm i +npm run build +node build ``` ### Docker -```console -$ docker-compose up --build +```bash +docker compose up --build ```