mirror of https://codeberg.org/ashley/poke.git synced 2024-12-25 08:18:43 +01:00

History

wait-what f986884f85 add .gitignore for rust target (build artifacts)		2024-04-22 22:13:35 +03:00
..
src	lmao	2024-01-21 15:28:46 +00:00
.gitignore	add .gitignore for rust target (build artifacts)	2024-04-22 22:13:35 +03:00
Cargo.lock	inital source for january	2023-12-10 10:25:26 +00:00
Cargo.toml	inital source for january	2023-12-10 10:23:48 +00:00
Dockerfile	inital source for january	2023-12-10 10:23:48 +00:00
flake.lock	inital source for january	2023-12-10 10:25:26 +00:00
gitlab-ci.yml	inital source for january	2023-12-10 10:23:48 +00:00
LICENSE	inital source for january	2023-12-10 10:23:48 +00:00
README.md	inital source for january	2023-12-10 10:23:48 +00:00

README.md

January

Description

Image proxy and metadata scraper.

Features:

Can scrape metadata from websites, e.g. OpenGraph
Can scrape embeds from websites, e.g. YouTube, Spotify

Stack

Actix

Usage

Use /embed?url=<url> to generate an embed for given URL.
Use /proxy?url=<url> to fetch and serve a remote image.

Resources

Revolt

Revolt Project Board (Submit feature requests here)
Revolt Testers Server
Contribution Guide

CLI Commands

Command	Description
`cargo build`	Build/compile January.
`cargo run`	Run January.
`cargo fmt`	Format January. Not intended for PR use to avoid accidentally formatting unformatted files.

Contributing

The contribution guide is located at developers.revolt.chat/contributing. Please note that a pull request should only take care of one issue so that we can review it quickly.