Wasp bot is a constantly running nodejs server that serves different purposes:
- Acting as a Discord bot for our Discord community.
- Sending Wasp analytics reports.
Copy env.example to .env and fill it with your PostHog API key and Discord bot token.
Both are needed to run bot locally, but only PostHog API key is needed to run just analytics locally.
Run npm install for the first time or after any changes in npm deps.
Also, run npm run prepare to set up pre-commit hooks (for stuff like code formatting and linting!).
When developing, run the bot server locally with npm run buildAndStartBot. This will actually connect it to the Discord server, so you will have two bots running at the same time -> production one, and your development one. So test quickly what you need and then shut it down.
Run npm run buildAndCalcAnalytics to run analytics manually and get the report in the CLI.
Deployed instance of server is running on Heroku. Whatever you push to production branch automatically gets re-deployed to Heroku.
Heroku cares about Procfile that we have in the root of the project, and will run the command there to start the project once deployed.
Heroku knows it is a node project, so it will run npm install when deploying it, which will also run npm run postinstall, which is why it all works, because npm run postinstall does building (of TS).