Skip to content

StowardHQ/Stoward-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

21 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Stoward Bot

The official discovery bot for the Stoward platform.


πŸ›°οΈ Overview

Stoward Bot powers discovery features for the Stoward platform!

Built with TypeScript using StoatX.


πŸ“¦ Installation

Clone Repository

git clone https://github.com/StowardHQ/Stoward-bot stoward-bot
cd stoward-bot

Install Dependencies

Using pnpm:

pnpm install

Tip

pnpm is preferred


βš™οΈ Environment Variables

Create a .env file in the root directory:

TOKEN=
DISCOVERY_API_KEY=
PREFIX=s!

Important

Never commit your .env file publicly.


πŸš€ Development

Start the bot in development mode:

pnpm dev

πŸ—οΈ Build

Compile TypeScript into production files:

pnpm build

🌐 Production

Run the compiled production build:

pnpm start

πŸ“ Project Structure

src/
β”œβ”€β”€ commands/
β”œβ”€β”€ utils/
└── index.ts

πŸ“œ Scripts

Script Description
pnpm dev Start development environment
pnpm build Compile TypeScript
pnpm start Start production build
pnpm lint Run ESLint
pnpm lint:fix Automatically fix lint issues
pnpm fmt Format source files

🀝 Contributing

Pull requests, suggestions, and issue reports are welcome.

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Open a pull request

Tip

Keep commits focused and descriptive for easier review.


πŸ”— Links

Platform Link
🌍 Website https://stoward.space
πŸ’» GitHub https://github.com/StowardHQ
πŸ’¬ Support Server https://stt.gg/YdbvBN6q

About

The Stoat bot for Stoward! This handles adding your server and bumping πŸ’ƒπŸ•Ί

Topics

Resources

License

Stars

Watchers

Forks

Contributors