33 lines
1.0 KiB
Markdown
33 lines
1.0 KiB
Markdown
# Clippable
|
|
|
|
A small self hostable alternative to streamable. Built with Rocket.rs
|
|
|
|
## Status
|
|
|
|
Right now the public API is being built so that as long as there videos to serve
|
|
the application should serve
|
|
|
|
## Admin Setup/Configuration
|
|
|
|
There are a few environment variables that can be configured:
|
|
|
|
* `CLIPS_DIR` : default = `/media/clips`
|
|
|
|
* `THUMBS_DIR`: default = `/media/thumbnails`
|
|
|
|
## Building the backend
|
|
|
|
Currently the project relies on Rust Nightly to build due to a requirement in
|
|
Rocket however as that framework moves to Rust Stable so to will this project.
|
|
|
|
## Building frontend javascript
|
|
|
|
Currently the website's javascript is written in typescript then compiled to
|
|
Javascript. The output directory is `/api/static/js/` which means `mkdir -p api/static/js`
|
|
must be ran in order to ensure that output directory is present and compilation
|
|
succeeds. There are no dependencies and is only written in typescript to
|
|
enforce some level of consistency among contributor code.
|
|
|
|
## Roadmap
|
|
|
|
_Check the /roadmap.md_ |