https://github.com/sitegui/lindy-hop
A static platform to share Lindy Hop videos
https://github.com/sitegui/lindy-hop
Last synced: over 1 year ago
JSON representation
A static platform to share Lindy Hop videos
- Host: GitHub
- URL: https://github.com/sitegui/lindy-hop
- Owner: sitegui
- Created: 2025-02-06T17:57:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-23T16:38:44.000Z (over 1 year ago)
- Last Synced: 2025-02-23T17:32:59.586Z (over 1 year ago)
- Language: Rust
- Size: 133 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lindy Hop videos
This is a personal platform to host and share videos from my classes and camps of Lindy Hop.
## To publish
```shell
npm install -g firebase-tools
firebase login
firebase deploy
```
## Data format
This section documents the format of the files in the `data` folder, which is not commited into git, but should be
backed up as it contains all the necessary data to build and update the site.
### `data/new_lindy_files`
Produced by the command `copy-new-videos`, which will copy the most recent videos from the connected Android phone.
### `data/tagging_in_progress/part-X`
Produced by the command `prepare-new-videos-for-tagging`, which will move the videos from `data/new_lindy_files` into
separate folders to easy the inclusion of a large batch of files
### `data/copied_files.json`
Auto-managed file to remember all files that were copied from the Android phone
### `data/restrictions.json`
List the access rules used to protect some videos with a code.
### `data/all_tags.txt`
Contains all video names and related tags. This can be manually edited later, making it easy to batch update the whole
library. This is auto-updated by the command `build`.
### `data/videos`
Contains all videos in the library. The file name is the hash of the original video contents. Videos are copied from
`data/tagging_in_progress` into here by the command `build`.
### `original_data/videos`
Large video files are re-encoded so that they can use less storage and bandwidth. When this happens, the re-encoded
video is stored in `data/videos` and the original is copied into `original_data/videos`. This allows the original data
to be left out of the main backup.
Note that the file name is kept, so it stays the hash of the original content.
## Build format
The `build` is also ignored by Git, but unlike `data` does not need to be backed up. It represents the data that will
be published to the web hosting.
### `build/videos`
The same content as `data/videos`
### `build/thumbnails`
Contains all the thumbnails for the videos. The file name is the truncated hash of the video content. The thumbnails are
public information, but the full video name should only be known if the video is public or the user has the correct code
to access it.
### `build/**.html`
Final public pages.