joel bot
This commit is contained in:
51
README.md
51
README.md
@@ -1,15 +1,54 @@
|
||||
# crunk-bun
|
||||
# Joel Discord Bot
|
||||
|
||||
To install dependencies:
|
||||
A Discord bot with AI-powered responses and message tracking.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
# Set environment variables
|
||||
cp .env.example .env
|
||||
# Edit .env with your tokens
|
||||
|
||||
# Run in development mode
|
||||
bun run dev
|
||||
|
||||
# Run in production
|
||||
bun run start
|
||||
```
|
||||
|
||||
To run:
|
||||
## Project Structure
|
||||
|
||||
```bash
|
||||
bun run index.ts
|
||||
See [src/README.md](src/README.md) for detailed architecture documentation.
|
||||
|
||||
```
|
||||
src/
|
||||
├── core/ # Bot client, config, logging
|
||||
├── commands/ # Slash commands
|
||||
├── events/ # Discord event handlers
|
||||
├── features/ # Feature modules (Joel AI, message logging)
|
||||
├── services/ # External services (AI providers)
|
||||
├── database/ # Database schema and repositories
|
||||
└── utils/ # Shared utilities
|
||||
```
|
||||
|
||||
This project was created using `bun init` in bun v1.1.3. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --------------------- | -------------------------- |
|
||||
| `DISCORD_TOKEN` | Discord bot token |
|
||||
| `REPLICATE_API_TOKEN` | Replicate API token for AI |
|
||||
|
||||
## Scripts
|
||||
|
||||
| Script | Description |
|
||||
| --------------------- | --------------------------- |
|
||||
| `bun run dev` | Development with hot reload |
|
||||
| `bun run start` | Production start |
|
||||
| `bun run build` | Build for production |
|
||||
| `bun run db:generate` | Generate DB migrations |
|
||||
| `bun run db:migrate` | Run DB migrations |
|
||||
| `bun run db:studio` | Open Drizzle Studio |
|
||||
| `bun run typecheck` | Type check without emit |
|
||||
|
||||
Reference in New Issue
Block a user