Skip to content

Rendless is an open source Image to API editor. The main usecase is rendering dynamic OG image

License

Notifications You must be signed in to change notification settings

constantgillet/rendless

Folders and files

NameName
Last commit message
Last commit date

Latest commit

00c472b · Jan 21, 2025
Jul 31, 2024
Sep 9, 2024
Jun 6, 2024
Jun 3, 2024
Jul 29, 2024
Jul 1, 2024
Aug 4, 2024
Jun 3, 2024
Jun 3, 2024
Jul 1, 2024
Aug 21, 2024
Jun 3, 2024
Jan 21, 2025
Jun 6, 2024
Jun 3, 2024
Jul 21, 2024
Jul 21, 2024
Feb 6, 2024
Dec 15, 2023
Jun 3, 2024
Jun 3, 2024
Jun 6, 2024
Jun 3, 2024

Repository files navigation

Rendless

Description: Rendless is an open source Image to API editor. The main usecase is rendering dynamic OG image

  • Technology stack: It's using Remix as fullstack framework. Radix as style. Lucia for the authentification. Satori for the image rendering. Prisma as ORM.
  • Status: Alpha. The software is stable but is still missing style features.

Links:

  • Platform link: Link
  • Documentation link: Link

Screenshot:

Requirements

  • Nodejs: > 18
  • S3 compatible bucket
  • Postgresql database

Installation

  • npm i : install the required packages
  • npm run build : compile the application for production
  • npm start: Once the application is build you can start it

Configuration

Some environment variables are required:

  • DATABASE_URL: URL of the postgresql database.
  • WEBSITE_URL: URL of the website.
  • BUCKET_URL: URL of the s3 bucket
  • BUCKET_NAME: name of the s3 bucket
  • SPACES_KEY: accessKeyId of the s3 bucket
  • SPACES_SECRET: Secret key of the s3 bucket
  • RESEND_API_KEY: API key of resend

Make sure to set these environment variables before running the application.

Optionnal environment variables

  • IMAGES_FOLDER: The folder where images will be saved: default value is "ogimages/cached/"
  • EMAIL_FROM: The email that will send email: default is "noreply@rendless.com"

Usage

Take a look at the documenation for using learning how to use the rendering API.

Known issues

  • Language selection
  • Text responsive when rendering
  • Fonts bug when rendering with satori

Getting help

Just open an Issue or contact me on x.com

Open source licensing info

LICENSE


Credits and references

  1. Satori
  2. Moveable

About

Rendless is an open source Image to API editor. The main usecase is rendering dynamic OG image

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages