flo-bit.dev
[READ-ONLY] Mirror of https://github.com/flo-bit/youtube-party-dj. democratic youtube player, everyone can vote and add songs, uni project, made with uix
Merge pull request #32 from flo-bit/update-readme
update readme
author
Florian
committer
GitHub
date
(Jun 12, 2024, 2:38 PM +0200)
commit
72fb78ba
72fb78ba7439532d79b9fd88ae24d68d9ae98824
parent
40e423a6
40e423a6afea01694e2f7ccce925c4ffe5ec25f0
+10
-55
+10
-55
README.md
+10
-55
README.md
···
1
1
# Youtube Party DJ
2
2
3
+
Play a youtube queue on one device and other devices can add songs to the queue, as well as vote on songs. Highest voted song plays next. WIP.
4
+
5
+
## demo
6
+
7
+
short demo video (left player, right a client)
8
+
9
+
10
+
https://github.com/flo-bit/youtube-party-dj/assets/45694132/ac43fc09-d47f-4611-9991-0aa098f1105a
11
+
12
+
3
13
## Development
4
14
5
15
1. Clone the repository
···
31
41
```
32
42
33
43
7. Open the browser and navigate to `http://localhost`
34
-
35
-
36
-
37
-
38
-
39
-
40
-
## UIX Base Project
41
-
42
-
This repository provides a simple UIX setup, including backend, frontend and configuration files.
43
-
44
-
*[UIX Docs](https://docs.unyt.org/manual/uix/getting-started)*
45
-
46
-
## Project Structure
47
-
48
-
### Directories
49
-
The source code is split into three directories.
50
-
51
-
The `backend` directory contains the backend logic that runs on [Deno](https://deno.com/).
52
-
53
-
The `frontend` directory contains the code for the frontend clients (running in the web browser).
54
-
55
-
The default export of the `backend/entrypoint.ts` and `frontend/entrypoint.ts` determine what content
56
-
gets displayed when visiting a page in the browser.
57
-
58
-
The `common` directory contains common modules that can be initialized both in the browser and in the deno backend - they can be imported from modules in the `backend` and `frontend` directory.
59
-
60
-
The directory names (`backend`, `frontend`, `common`) are important to tell UIX which code runs in which context. The default names can also be changed in the `app.dx` config file.
61
-
62
-
### app.dx
63
-
64
-
The `app.dx` configuration file is required for a UIX app to run. It needs to contain at least the app name.
65
-
The `app.dx` has to be placed next to the app directories (`frontend`, `backend` and `common`) in the default configuration.
66
-
67
-
## Cross realm imports
68
-
69
-
Frontend and common modules can import exported values from backend modules.
70
-
In the background, special interface module files are generated, making sure that the backend source code is never exposed to the frontend endpoints.
71
-
72
-
Access to these exports can be limited by setting DATEX permission filters.
73
-
74
-
## Development
75
-
76
-
Compilation of the TS files is not required. The project can be deployed as is.
77
-
There is a devcontainer set up, containing the latest deno version.
78
-
79
-
To run the project, Deno has to be installed:
80
-
hit `CTRL`+`F5` to launch the project with the launch configuration.
81
-
82
-
With the `--live` option, frontend browser tabs are automatically reloaded when a file has changed, which is useful for development, but should not be used in production.
83
-
84
-
This command starts the backend endpoint and also exposes a web server on port 80 or another available port.
85
-
86
-
---
87
-
88
-
<sub>© unyt 2024 • [unyt.org](https://unyt.org)</sub>