The weeb for the next gen discord boat - Wamellow
wamellow.com
bot
discord
Update README.md
+33
-18
+33
-18
README.md
+33
-18
README.md
···
10
10
11
11
If you need help developing with this, join **[our Discord Server](https://discord.com/invite/yYd6YKHQZH)**.
12
12
13
+
Note that this project is not meant to be used by anyone else, including other bots, as it is specifically designed for our bot and the backend API stays private. We will not provide support for this project if you use it for your own bot, though you are allowed to by the license.
14
+
13
15
## Setup
14
16
Clone this repo with the following commands:
15
17
···
19
21
20
22
Create a `.env` file and add the following values:
21
23
```env
24
+
# Register a https://www.geetest.com/en/ account, this is used for
22
25
NEXT_PUBLIC_CAPTCHA_ID=""
23
-
NEXT_PUBLIC_API="https://api.local.wamellow.com/v1"
26
+
27
+
# The API URL, this is the base URL for the backend
28
+
NEXT_PUBLIC_API="https://api.wamellow.com/v1"
29
+
API_SECRET=""
30
+
31
+
# The Nekostic API URL, https://github.com/Luna-devv/nekostic
24
32
NEXT_PUBLIC_NEKOSTIC="https://nekostic.wamellow.com/statistics"
25
-
NEXT_PUBLIC_LOGIN="https://discord.com/oauth2/authorize?client_id=1116414956972290119&redirect_uri=https://local.wamellow.com/login&response_type=code&permissions=1426738113654&prompt=none&scope=identify+email+guilds"
26
-
NEXT_PUBLIC_BASE_URL="https://local.wamellow.com"
27
33
28
-
API_SECRET="a"
34
+
# The base URL for the website, this is used for the meta tags and other things
35
+
NEXT_PUBLIC_BASE_URL="https://wamellow.com"
29
36
37
+
# https://plausible.com analytics
30
38
PLAUSIBLE_API="https://analytics.wamellow.com/api"
31
39
PLAUSIBLE_DOMAIN="wamellow.com"
32
40
PLAUSIBLE_API_KEY=""
33
41
34
-
RATINGS_API="http://100.65.0.1:5002"
42
+
# The base URL for the ratings API
43
+
RATINGS_API="http://localhost:5002"
44
+
45
+
# The Discord client ID and bot token
35
46
CLIENT_ID="1125449347451068437"
47
+
DISCORD_TOKEN=""
36
48
37
-
DISCORD_TOKEN=""
49
+
# A personal GitHub access token (read repositories)
50
+
GITHUB_TOKEN=""
38
51
```
39
-
For the `NEXT_PUBLIC_CAPTCHA_ID` register a https://www.geetest.com/en/ account, this is used for /passport's.
40
-
For the `API_SECRET` hack my computer to get access to the backend API and it's secrets. (dun't duh)
41
-
For the `PLAUSIBE_*` stuff you have to either create or selfhost https://plausible.com/
42
-
For the `RATINGS_API` enter a ip/domain to a ratings api duh, read the typings for a structure.
43
-
For the `CLIENT_ID` enter your Discord client id.
44
-
For the `DISCORD_TOKEN` go on repl.it and find a random repo that leaks the token and use it.
45
52
46
-
## Deploy
47
-
The bun package manager is cool, the runtime sucks imo tho, you can also use pnpm.
53
+
## Developing
54
+
This project uses pnpm with nodejs, to start developing, run:
48
55
49
-
To run the develoment server run
50
56
```bash
51
-
bun dev
57
+
pnpm install
58
+
pnpm dev
52
59
```
53
60
61
+
If you work on this project, please note that nextui is being phased out in favor of shadcn/ui, so please use the latter for new components.
62
+
63
+
## Deploy
54
64
To build and run the website use
55
65
```bash
56
-
bun build
57
-
bun start
66
+
pnpm build
67
+
pnpm start
68
+
```
69
+
or
70
+
```bash
71
+
docker build -t mw-web .
72
+
docker compose up -d
58
73
```