diff --git a/README.md b/README.md index a183c1f..a8abca2 100644 --- a/README.md +++ b/README.md @@ -88,4 +88,15 @@ giphyAPIKey= ownerId= statusChannelId= clientId= -``` \ No newline at end of file +``` + +## Running NodBot-dev Locally for Debugging + +1. Ensure that the `nodbot-dev` Docker container is stopped on the VPS. +2. Create an SSH tunnel to the MariaDB instance on the VPS: + `ssh -L 3307:localhost:3307 vps` +3. Install NodeJS LTS (18 right now) +4. Install packages: + `npm i` +5. Create a `.env` file and populate it +6. Launch and debug! \ No newline at end of file