Add README

This commit is contained in:
Admin 2023-05-03 18:33:59 -04:00
parent f70376fe6f
commit aa97cc4d8c

33
web/README.md Normal file
View File

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