Go to file

shockrah d87d689f03 * Seperating build stages		2021-10-18 00:31:30 -07:00
api	- No more grabbing no directory entries in categories	2021-10-17 21:26:04 -07:00
gitpage	+ more content in about section and packaging now	2021-10-18 00:29:59 -07:00
scripts	* fixing pad theme name	2021-10-17 16:40:19 -07:00
ts	* typo in og tags	2021-10-17 21:22:13 -07:00
.gitattributes	* LFS installed for image tracking	2021-10-05 15:54:50 -07:00
.gitignore	* Fixing broken scss links in vps	2021-10-17 19:07:59 -07:00
.gitlab-ci.yml	* Seperating build stages	2021-10-18 00:31:30 -07:00
.gitmodules	+ Gitpage with hugo	2021-10-16 21:11:09 -07:00
Cargo.lock	- Removing clippable-cli tool as it's not useful	2021-10-16 19:51:45 -07:00
Cargo.toml	- Removing clippable-cli tool as it's not useful	2021-10-16 19:51:45 -07:00
readme.md	+ Pipeline for building simple package for linux	2021-10-16 19:37:32 -07:00

readme.md

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