Contributing
Contributions are welcome. Please open a Pull Request on GitHub.
Development setup
git clone https://github.com/mhdzumair/MediaFlow-Proxy-Light
cd MediaFlow-Proxy-Light
cargo build
Run in development mode
CONFIG_PATH=./config.toml cargo run
Tests
cargo test
Linting
cargo fmt
cargo clippy -- -D warnings
Adding an extractor
Extractors live in src/extractors/. Each extractor is a Rust struct that implements the Extractor trait. To add a new host:
- Create
src/extractors/<host>.rsimplementingExtractor - Register it in
src/extractors/factory.rs(theExtractorFactory::_extractorsmap) - Add the host to the
docs/usage/extractor.mdtable - Add an integration test URL to
config-example.tomlunder[test_urls]
Reporting issues
Please open an issue on GitHub with:
- Your platform and version
- Steps to reproduce
- Expected vs actual behaviour
- Relevant logs (set
APP__LOG_LEVEL=debug)