Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spedrickson/ytchat-frontend
Quasar chat history frontend for ytchat-backend
https://github.com/spedrickson/ytchat-frontend
mongodb python python3 quasar-cli quasar-framework vue vue3 youtube youtube-channel youtube-live-chat youtube-livestream
Last synced: 3 days ago
JSON representation
Quasar chat history frontend for ytchat-backend
- Host: GitHub
- URL: https://github.com/spedrickson/ytchat-frontend
- Owner: spedrickson
- Created: 2022-02-24T21:17:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-10T19:55:51.000Z (about 2 months ago)
- Last Synced: 2024-09-20T02:34:14.097Z (8 days ago)
- Topics: mongodb, python, python3, quasar-cli, quasar-framework, vue, vue3, youtube, youtube-channel, youtube-live-chat, youtube-livestream
- Language: Vue
- Homepage:
- Size: 2.05 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ytchat-frontend
## About
This was started as a practice project to learn the Quasar framework. It integrates with the related ytchat-backend and a MongoDB instance to render chat history for YouTube live chats.
## Limitations
Currently, the app takes an environment variable to determine where it should query for chat history. Since the related ytchat-backend program only works with a single YouTube channel as of now, this means multiple instances of ytchat-frontend would be required for multiple YouTube channels.
## Configuration
The backend URL needs to be set as an environment variable before starting:
```bash
# bash
YTCHAT_FRONTEND_API_URL=...
```
```bash
# powershell
$env:YTCHAT_FRONTEND_API_URL = "..."
```
#### Supported variables
| Variable | Purpose | Default |
|-------------------------|--------------------------------------------------------------------|------------------------------------------------------|
| YTCHAT_FRONTEND_API_URL | API URL for the ytchat-backend instance the frontend should query. | `https://ytchat-api.ngrok.io/api` (API key required) |
## Install the dependencies
```bash
yarn
```
### Start the app in development mode (hot-code reloading, error reporting, etc.)
```bash
quasar dev
```
### Lint the files
```bash
yarn lint
```
### Format the files
```bash
yarn format
```
### Build the app for production
```bash
quasar build
```
### Customize the configuration
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).