This commit is contained in:
orosmatthew 2023-09-14 11:31:46 -04:00
commit 9f43eadf99
4 changed files with 73 additions and 9 deletions

5
README.md Normal file
View File

@ -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.

23
extension/README.md Normal file
View File

@ -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.

36
sandbox/README.md Normal file
View File

@ -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
```

View File

@ -13,21 +13,21 @@ Build dependencies:
### For Development ### For Development
```console ```bash
$ npm install npm i
$ npm run dev npm run dev
``` ```
### For Production ### For Production
```console ```bash
$ npm install npm i
$ npm run build npm run build
$ node build node build
``` ```
### Docker ### Docker
```console ```bash
$ docker-compose up --build docker compose up --build
``` ```