The weeb for the next gen discord boat - Wamellow
wamellow.com
bot
discord
update readme
+66
-35
+66
-35
README.md
+66
-35
README.md
···
1
-
[](https://wamellow.com/support)
2
-
1
+
2
+
3
3
4
4
[](https://ko-fi.com/I3I6AFVAP)
5
5
6
-
**⚠️ In development, breaking changes ⚠️**
6
+
This is the official web application for the Mellow Discord bot. It includes the home page, leaderboards, passport, profile, and server management features.
7
7
8
-
## About
9
-
This is the [wamellow.com](https://wamellow.com) website for our Discord App, including the home page, leaderboards, passport, profile and server management.
8
+
> [!WARNING]
9
+
> This project is not meant for your own use without significant modifications; breaking changes may occur.
10
10
11
-
If you need help developing with this, join **[our Discord Server](https://discord.com/invite/yYd6YKHQZH)**.
11
+
* [Home](https://wamellow.com)
12
+
* [Invite Wamellow](https://wamellow.com/invite)
13
+
* [Documentation](https://wamellow.com/docs/index)
14
+
* [Profile](https://wamellow.com/profile)
15
+
* [Dashboard](https://wamellow.com/dashboard)
12
16
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.
17
+
## Setup
14
18
15
-
Other open source projects relating to Wamellow can be found on [wamellow.com/team](https://wamellow.com/team).
19
+
To get started with this project, you'll need to have the following installed:
16
20
17
-
## Setup
18
-
Clone this repo with the following commands:
21
+
* [Node.js](https://nodejs.org/en/) (v18 or higher)
22
+
* [Bun](https://bun.sh/)
19
23
24
+
1. **Clone the repository:**
20
25
```bash
21
26
git clone https://github.com/Luna-devv/mellow-web
22
27
```
23
28
24
-
Create a `.env` file and add the following values:
29
+
2. **Install the dependencies:**
30
+
```bash
31
+
bun install
32
+
```
33
+
34
+
3. **Create a `.env` file:**
35
+
Create a `.env` file in the root of the project and add the following environment variables:
36
+
25
37
```env
26
-
# Register a https://www.geetest.com/en/ account, this is used for
27
-
NEXT_PUBLIC_CAPTCHA_ID=""
38
+
# The base URL for the web application
39
+
NEXT_PUBLIC_BASE_URL="https://wamellow.com"
28
40
29
-
# The API URL, this is the base URL for the backend
41
+
# The base URL for the backend API
30
42
NEXT_PUBLIC_API="https://api.wamellow.com/v1"
31
43
API_SECRET=""
32
44
33
-
# The Nekostic API URL, https://github.com/Luna-devv/nekostic
34
-
NEXT_PUBLIC_NEKOSTIC="https://nekostic.wamellow.com/statistics"
35
-
36
-
# The base URL for the website, this is used for the meta tags and other things
37
-
NEXT_PUBLIC_BASE_URL="https://wamellow.com"
38
-
39
-
# https://plausible.com analytics
45
+
# The API URL for the Plausible analytics service
40
46
PLAUSIBLE_API="https://analytics.wamellow.com/api"
47
+
48
+
# The domain and api key for the Plausible analytics service
41
49
PLAUSIBLE_DOMAIN="wamellow.com"
42
50
PLAUSIBLE_API_KEY=""
43
51
44
-
# The base URL for the ratings API
45
-
RATINGS_API="http://localhost:5002"
52
+
# The client ID and token for the Discord bot
53
+
NEXT_PUBLIC_CLIENT_ID="1116414956972290119"
54
+
DISCORD_TOKEN=""
46
55
47
-
# The Discord client ID and bot token
48
-
NEXT_PUBLIC_CLIENT_ID="1125449347451068437"
49
-
DISCORD_TOKEN=""
56
+
# The public key for the Turnstile captcha service
57
+
NEXT_PUBLIC_TURNSTILE_KEY=""
50
58
51
-
# A personal GitHub access token (read repositories)
59
+
# A personal GitHub access token with read:repositories scope
52
60
GITHUB_TOKEN=""
61
+
62
+
# The token for the top.gg API
63
+
TOPGG_TOKEN=""
64
+
65
+
# The public key for Bluesky
66
+
BLUESKY_PUBLIC_KEY=""
67
+
68
+
# The base64 encoded imprint data
69
+
IMPRINT_BASE64=""
53
70
```
54
71
55
72
## Developing
56
-
This project uses pnpm with nodejs, to start developing, run:
73
+
74
+
To start the development server, run the following command:
57
75
58
76
```bash
59
-
bun install
60
77
bun dev
61
78
```
62
79
63
-
## Deploy
64
-
To build and run the website use
80
+
This will start the development server on `http://localhost:3000`.
81
+
82
+
## Deployment
83
+
84
+
To build and run the web application, use the following commands:
85
+
65
86
```bash
66
-
bun build
87
+
bun run build
67
88
bun start
68
89
```
69
90
or
70
91
```bash
71
-
docker build -t mw-web .
72
-
docker compose up -d
92
+
docker compose up --build -d
73
93
```
74
-
(docker is not tested nor maintained)
94
+
95
+
## Contributing
96
+
97
+
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
98
+
99
+
1. Fork the repository.
100
+
2. Create a new branch for your changes.
101
+
3. Make your changes and commit them.
102
+
4. Push your changes to your fork.
103
+
5. Create a pull request.
104
+
105
+
If you need help with any of these steps, feel free to join our [Discord server](https://discord.com/invite/yYd6YKHQZH).