[READ-ONLY] Mirror of https://github.com/trueberryless-org/release-image-generator. API for getting beautiful images with short text and ran release-image-generator.trueberryless.org

automation

Fork

129 8 7

README.md

Release Image Generator #

This project generates random images with customizable patterns, colors, and text overlays.

API Usage #

Endpoint: `GET /api/generateImage` #

Query Parameters #

Parameter	Type	Default	Options
`text`	string	none	Any text to display
`width`	number	1920	Any positive integer
`height`	number	1080	Any positive integer
`fontFamily`	string	readexpro	See supported fonts below
`fontWeight`	string	bold	bold, medium, light
`primaryColor`	string	random	Any valid CSS color or hex
`imageFormat`	string	png	png, jpg, jpeg
`patternType`	string	random	grid, dots, waves, triangles, hexagons, concentric, circuitry, maze, steps, geometry
`noiseLevel`	string	medium	low, medium, high
`seed`	number	`Date.now()`	Any positive integer

Supported Fonts #

bigshoulders
inter
jetbrainsmono
lato
opensans
poppins
quicksand
raleway
readexpro
redhattext
roboto
robotomono
rubik
sourcecodepro

Supported Weights #

bold
medium
light

Example Requests #

Here are some example requests, you can also try out configuring your desired image on https://release-image-generator.netlify.app.

Simple image with text:

https://release-image-generator.netlify.app/api/generateImage?text=Hello+World

Custom dimensions and color:

https://release-image-generator.netlify.app/api/generateImage?text=Release+v1.0&width=1920&height=1080&primaryColor=%23ff6b6b

Specific pattern and font:

https://release-image-generator.netlify.app/api/generateImage?text=Welcome&patternType=hexagons&fontFamily=poppins&fontWeight=bold

JPEG format with low noise:

https://release-image-generator.netlify.app/api/generateImage?text=Banner&imageFormat=jpeg&noiseLevel=low

Development #

pnpm install
pnpm dev

The image rendering uses the native canvas module, so pnpm install must be allowed to run its install script (already configured in pnpm-workspace.yaml).

Command	Action
`pnpm dev`	Start the local development server
`pnpm build`	Build the site to `./dist/`
`pnpm check`	Type check the project
`pnpm lint`	Lint with oxlint
`pnpm knip`	Find unused files and dependencies
`pnpm test`	Run the unit tests
`pnpm test:e2e`	Run the end-to-end tests (Playwright)