all repos — stealth-developers @ 6c5675d1edbca317e0193f2dca996b02b13c20de

README.md (view raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
# stealth developers

discord bot for the stealth developers community.

thanks arnav (idk wat u did but thanks)

## development

### requirements

- bun
  - get it here https://bun.sh/

- a mongodb database
  - get it here https://www.mongodb.com/try/download/community
  - or, host it on a service like https://www.mongodb.com/cloud/atlas

- a discord bot token
  - create a bot here https://discord.com/developers/applications
  - add the bot to your server with the `bot` and `applications.commands`
    scopes

### setup

clone the repo and install any deps:
```sh
git clone https://github.com/willow-contrib/stealth-developers.git
cd stealth-developers
bun install
```

configure variables in `.config.{ENVIRONMENT}.json`, copy `.config.example.json`
to `.config.json` and fill in the values.

`ENVIRONMENT` is defined by the `NODE_ENV` environment variable; if not set, it
will default to `DEV`.


### running

run the bot with:
```sh
bun run start
```

### development

if you want to run the bot in development mode, you can use:
```sh
bun run dev
```

this will watch for changes in the code and automatically restart the bot when
changes are detected, beware of rate limits.

## copying

this project is licensed under the copyleft gnu agplv3.0, you can find the full
license text in [`COPYING.aglpv3`](./COPYING.agplv3).