Initial commit

packages/star-kitten-bot/README.md

@@ -0,0 +1,67 @@
+# Star Kitten Discord Bot
+
+A Discord bot for [EVE Online](https://www.eveonline.com/) built with [bun](https://bun.sh/) and [@star-kitten/lib](https://git.f302.me/jb/star-kitten)
+
+# [Install Star Kitten](https://discord.com/oauth2/authorize?client_id=1288711114388930601)
+
+## Running the Bot
+
+This bot runs on [Bun](https://bun.sh/)! To install Bun, run one of the following commands.
+
+_Linux & MacOS_
+
+```bash
+curl -fsSL https://bun.sh/install | bash
+```
+
+_Windows_
+
+```bash
+powershell -c "irm bun.sh/install.ps1 | iex"
+```
+
+---
+
+### Install bot dependencies
+
+```bash
+bun install
+```
+
+### Download static eve reference data & Hoboleaks archive from [EVE Ref](https://everef.net/)
+
+```bash
+bun get-data
+```
+
+### Run the bot
+
+```bash
+bun dev
+```
+
+## Environment Variables
+
+Create a .env file in the root directory with the following values:
+
+```yaml
+# Discord - https://discord.com/developers/applications
+DISCORD_BOT_TOKEN=YOUR_BOT_TOKEN
+
+#General
+BASE_URL=http://localhost:3000
+DEBUG=true
+PORT=3000
+NODE_ENV=development
+LOG_LEVEL=debug
+
+# EVE - https://developers.eveonline.com/applications
+EVE_CLIENT_ID=YOUR_EVE_CLIENT_ID
+EVE_CLIENT_SECRET=YOUR_EVE_SECRET
+EVE_CALLBACK_URL=http://localhost:3000/auth/callback
+ESI_USER_AGENT=ADD_YOUR_USER_AGENT_INFO_HERE
+
+# For using Janice's Appraisal API
+JANICE_KEY=XXX
+
+```