shi.gg
The weeb for the next gen discord boat - Wamellow
wamellow.com
bot
discord
1
2
3
4[](https://ko-fi.com/I3I6AFVAP)
5
6This is the official web application for the Mellow Discord bot. It includes the home page, leaderboards, passport, profile, and server management features.
7
8> [!WARNING]
9> This project is not meant for your own use without significant modifications; breaking changes may occur.
10
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)
16
17## Setup
18
19To get started with this project, you'll need to have the following installed:
20
21* [Node.js](https://nodejs.org/en/) (v18 or higher)
22* [Bun](https://bun.sh/)
23
241. **Clone the repository:**
25```bash
26git clone https://github.com/shi-gg/mellow-web
27```
28
292. **Install the dependencies:**
30```bash
31bun install
32```
33
343. **Create a `.env` file:**
35Create a `.env` file in the root of the project and add the following environment variables:
36
37```env
38# The base URL for the web application
39NEXT_PUBLIC_BASE_URL="https://wamellow.com"
40
41# The base URL for the backend API
42NEXT_PUBLIC_API="https://api.wamellow.com/v1"
43API_SECRET=""
44
45# The API URL for the Plausible analytics service
46PLAUSIBLE_API="https://analytics.wamellow.com/api"
47
48# The domain and api key for the Plausible analytics service
49PLAUSIBLE_DOMAIN="wamellow.com"
50PLAUSIBLE_API_KEY=""
51
52# The client ID and token for the Discord bot
53NEXT_PUBLIC_CLIENT_ID="1116414956972290119"
54DISCORD_TOKEN=""
55
56# The public key for the Turnstile captcha service
57NEXT_PUBLIC_TURNSTILE_KEY=""
58
59# A personal GitHub access token with read:repositories scope
60GITHUB_TOKEN=""
61
62# The token for the top.gg API
63TOPGG_TOKEN=""
64
65# The public key for Bluesky
66BLUESKY_PUBLIC_KEY=""
67
68# The base64 encoded imprint data
69IMPRINT_BASE64=""
70```
71
72## Developing
73
74To start the development server, run the following command:
75
76```bash
77bun dev
78```
79
80This will start the development server on `http://localhost:3000`.
81
82## Deployment
83
84To build and run the web application, use the following commands:
85
86```bash
87bun run build
88bun start
89```
90or
91```bash
92docker compose up --build -d
93```
94
95## Contributing
96
97Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
98
991. Fork the repository.
1002. Create a new branch for your changes.
1013. Make your changes and commit them.
1024. Push your changes to your fork.
1035. Create a pull request.
104
105If you need help with any of these steps, feel free to join our [Discord server](https://discord.com/invite/yYd6YKHQZH).