-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
47 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
BOT_TOKEN= | ||
MONGO_URI= | ||
REDIS_URI= | ||
PROCESS_ENV= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,50 @@ | ||
# zentbot | ||
# Miss Hatsune | ||
Miss Hatsune is a Discord bot, written on top of [Deno](https://github.com/denoland/deno) runtime with TypeScript and using [discord.js](https://github.com/discordjs/discord.js/).\ | ||
\ | ||
The bot is developed specifically for ZentSchool server with love<3. | ||
|
||
To install dependencies: | ||
# Requirements | ||
- Deno >= `v2.0` | ||
- MongoDB | ||
- Redis | ||
|
||
```bash | ||
bun install | ||
# Installation | ||
## **Step 1** - Clone the repository: | ||
``` | ||
git clone https://github.com/louiszn/miss-hatsune | ||
cd miss-hatsune | ||
``` | ||
|
||
## **Step 2** - Install dependencies | ||
``` | ||
deno install | ||
``` | ||
|
||
## **Step 3** - Config your `.env` file | ||
Copy from example env file | ||
``` | ||
cp .env.example .env | ||
``` | ||
|
||
Add value for each env key | ||
- `BOT_TOKEN`: Token of your Discord bot | ||
- `MONGO_URI`: Your MongoDB connection URI | ||
- `REDIS_URI`: Your Redis connection URI | ||
- `PROCESS_ENV`: Use `development` or `production` | ||
|
||
## **Step 4** - Config `src/config.ts` | ||
This file is used to config default values which the bot will use. Make it easier to config by using objects. The file is located in `src/config.ts` | ||
|
||
To run: | ||
## **Step 5** - Run the bot! | ||
Register application commands *(Only run this when you need to register commands. Mostly you will only use it once)* | ||
``` | ||
deno task deloy | ||
``` | ||
|
||
```bash | ||
bun run src/index.ts | ||
Run the bot | ||
``` | ||
deno task start | ||
``` | ||
|
||
This project was created using `bun init` in bun v1.1.29. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. | ||
# Contribution | ||
All of your contributions are welcome :D. Please make sure you have checked the issues/pull requests for the related content that you want me to do. |