Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zptxdev/quaver-web
Web dashboard add-on for Quaver.
https://github.com/zptxdev/quaver-web
discord-js svelte sveltejs web-addon
Last synced: 3 months ago
JSON representation
Web dashboard add-on for Quaver.
- Host: GitHub
- URL: https://github.com/zptxdev/quaver-web
- Owner: ZPTXDev
- Created: 2022-08-26T04:05:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T11:38:35.000Z (5 months ago)
- Last Synced: 2024-09-08T12:02:58.780Z (5 months ago)
- Topics: discord-js, svelte, sveltejs, web-addon
- Language: Svelte
- Homepage: https://quaver.zptx.dev
- Size: 2.68 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Quaver-Web
Web dashboard add-on for Quaver.
# ⚠️ Warning
Quaver-Web is in an experimental state. Unless you have good reason to, you should not be using it, especially in conjunction with a public instance of Quaver.
Please proceed with caution. If you need help, getting it started regardless, feel free to ask your question in the Discord server above.
# 🚀 Getting Started
## Prerequisites
Quaver-Web requires a functional instance of Quaver to work.
Ensure your Quaver configuration includes the following:
```json
"features": {
"web": {
"enabled": true,
"port": 3000,
"allowedOrigins": [
"http://localhost"
],
"encryptionKey": "Type an encryption key here",
"https": {
"enabled": false,
"key": "key.pem",
"cert": "cert.pem"
},
"dashboardURL": "http://example.com"
}
}
```
Please modify the configuration as necessary. You may refer to [Quaver Configuration Guide](https://github.com/ZPTXDev/Quaver/blob/master/CONFIGURATION.md) for more information.
## Setup
1. Clone the repository and run `npm install` to install dependencies.
2. Create a `.env` file in the root directory of the project and add the following:
```env
PUBLIC_WEBSOCKET_HOST=http://localhost:3000
PUBLIC_DISCORD_CLIENT_ID=123456789012345678
PUBLIC_SUPPORT_SERVER=http://discord.gg/
PUBLIC_PREMIUM_URL=http://example.com/premium
PRIVATE_SECURE=false
```
> Note: `PRIVATE_SECURE` must be set to `false` if you are running Quaver-Web on HTTP instead of HTTPS.
3. Run `npm run build` to build the project.
4. Run `npm run preview` to start the preview server. (default port is 4173)
5. Navigate to `http://localhost:4173` to view the dashboard.