StyAndCo/zappyzep
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add quick instructions for docker dev environment

Browse source
This commit is contained in:
Dragory 2022-06-26 15:31:20 +03:00
parent bc250209d8
commit b655085115
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docker/development/README.md Normal file
View file

@ -0,0 +1,27 @@
# Running the development environment
1. Install Docker
2. Fill the values in .env
3. Run `./docker-compose-dev.sh up` to start the development environment
4. Connect to the development environment with your editor's remote SSH feature (see below)
## Connecting with VSCode
1. Install the `Remote - SSH` plugin
2. Run `Remote-SSH: Connect to Host...`
* As the address, use `ubuntu@127.0.0.1:3002` where `3002` matches `DOCKER_DEV_SSH_PORT` in `.env`
* Use the password specified in `.env` as `DOCKER_DEV_SSH_PASSWORD`
3. Once connected, click `Open folder...` and select `/home/ubuntu/zeppelin`
## Connecting with JetBrains Gateway
* TODO (basically the same as VSCode instructions though)
## Starting the backend (bot + api)
These commands are run inside the dev container. You should be able to just open a terminal in your editor after connecting.
1. `cd ~/zeppelin/backend`
2. `npm ci`
3. `npm run migrate-dev`
4. `npm run watch`
## Starting the dashboard
1. `cd ~/zeppelin/dashboard`
2. `npm ci`
3. `npm run watch-build`