https://github.com/kiosion/toru
API for generating customizable image embeds of last.fm activity
https://github.com/kiosion/toru
elixir elixir-lang lastfm profile-readme profile-stats readme-badges readme-profile readme-stats
Last synced: 2 months ago
JSON representation
API for generating customizable image embeds of last.fm activity
- Host: GitHub
- URL: https://github.com/kiosion/toru
- Owner: kiosion
- License: other
- Created: 2022-04-06T06:41:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T23:27:00.000Z (5 months ago)
- Last Synced: 2024-10-30T14:42:31.476Z (4 months ago)
- Topics: elixir, elixir-lang, lastfm, profile-readme, profile-stats, readme-badges, readme-profile, readme-stats
- Language: Elixir
- Homepage: https://kiosion.github.io/toru/
- Size: 386 KB
- Stars: 44
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Toru
An API for generating customizable embeds of last.fm activity
## Demos 🚧
## Usage 🔧
Simply add the following snippet to your Github profile readme (or anywhere else you'd like to embed your last.fm activity):
```
```
You can append `?res=json` to get a JSON response:
```
GET https://toru.kio.dev/api/v1/{your_lfm_username}?res=json
->
{
status: 200,
data: {
url: "https://last.fm/music/X",
title: "X",
streamable: false,
playing: true,
cover_art: {
mime_type: "image/png",
data: "X"
},
artist: "X",
album: "X"
}
}
```
You can also connect to the Websocket endpoint - recieved frames will be of the "data" field above. Minute-interval pings are required to stay connected.
```
wss://toru.kio.dev/api/v1/ws/{your_lfm_username}
```
## Options ⚙️
Toru has a few parameters you can customize through query parameters:
#### Theme
The theme can be specified with `theme=`. Available themes are:
- dark/light
- shoji
- dracula
- nord
- solarized
- monokai
#### Border radius
The border radius of the embed can be specified as an integer with `border_radius`
#### Cover radius
The border radius of the album art can be specified as an integer with `cover_radius`
#### Blurred background
A blurred background can be enabled using `blur`:
#### Border width
The width of the borders can be specified (or removed by setting to '0') with `border_width`:
#### Custom SVG asset
You can alternativly specify a custom SVG asset with `svg_url=`. Toru will fill in the artist name, track title, album title, and cover art resource using the following template strings:
- Cover art -> `${cover_art}` (should be the 'src' attr, as it's sent as a b64-encoded image string)
- Artist -> `${artist}`
- Album -> `${album}`
- Track -> `${title}`
## Building / Testing 🔨
- Clone the repo
- Run `make install` to pull & compile needed dependencies
### Running
- Make sure you have an `.env` file in the project root, with `LFM_TOKEN` set to your last.fm API key, and optionally `PORT` set to the port you want to run the dev server on (default is 4000)
- Run `make dev` to run the livereload dev server, and `make test` to run all unit tests.
### Building a release
- Environment variables `LFM_TOKEN` and `PORT` are required to build a release
- `make release` compiles environment variables and builds a docker image with the release
- `make run` stops any previuosly running docker container, and runs the new release
## Contributing 🤝
Feel free to open an issue or pull request if you have suggestions or find any bugs!