Skip to content

vanxh/openbio

Repository files navigation

OpenBio

OpenBio

Open-source link-in-bio page builder with a customizable bento grid layout.

Discord Github Stars License Commits-per-month

OpenBio example

Features

  • Bento Grid Layout — drag-and-drop cards in a responsive bento grid
  • Multiple Card Types — links, notes, images, and videos
  • Custom Profiles — claim your openbio.app/username link
  • Social OAuth — sign in with GitHub or Google
  • Pro Plan — unlimited profile links with Stripe-powered subscriptions
  • OG Image Generation — auto-generated social preview images
  • Self-hostable — deploy your own instance with ease

Tech Stack

Getting Started

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/vanxh/openbio
cd openbio
  1. Install dependencies
bun install
  1. Copy .env.example to .env
cp .env.example .env
  1. Configure environment variables
Variable Required Description
DATABASE_URL Yes PostgreSQL connection string
BETTER_AUTH_SECRET Yes Auth secret (generate with openssl rand -hex 32)
BETTER_AUTH_URL Yes Your app URL (http://localhost:3000 for dev)
NEXT_PUBLIC_URL Yes Public app URL (http://localhost:3000 for dev)
RESEND_API_KEY Yes Resend API key for emails
UPSTASH_REDIS_REST_URL Yes Upstash Redis REST URL
UPSTASH_REDIS_REST_TOKEN Yes Upstash Redis REST token
BLOB_READ_WRITE_TOKEN Yes Vercel Blob token
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY Yes Stripe publishable key
STRIPE_SECRET_KEY Yes Stripe secret key
STRIPE_WEBHOOK_SECRET Yes Stripe webhook signing secret
STRIPE_PRO_MONTHLY_PRICE_ID Yes Stripe price ID for monthly plan
STRIPE_PRO_YEARLY_PRICE_ID Yes Stripe price ID for yearly plan
GITHUB_CLIENT_ID No GitHub OAuth client ID
GITHUB_CLIENT_SECRET No GitHub OAuth client secret
GOOGLE_CLIENT_ID No Google OAuth client ID
GOOGLE_CLIENT_SECRET No Google OAuth client secret
  1. Push the database schema
bun run db:push
  1. Start the development server
bun dev

The app will be running at http://localhost:3000.

Self-Hosting

OpenBio is designed to be deployed on Vercel:

  1. Fork this repository
  2. Create a new project on Vercel and import the fork
  3. Add the required environment variables in the Vercel dashboard
  4. Deploy

You can also deploy anywhere that supports Next.js — just make sure to set up the environment variables and a PostgreSQL database.

Contributing

Want to help build a better open-source link-in-bio page builder? Check out our contribution guidelines.

Top Contributors

Top Contributors

License

OpenBio is open source under the AGPLv3 license.

Releases

No releases published

Packages

 
 
 

Contributors

Languages