Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 1.32 KB

README.md

File metadata and controls

57 lines (45 loc) · 1.32 KB

smol tree

Basic, self-hosted app designed to replace centrally hosted link sharing services like Linktree. Built using Nextjs. Can easily be deployed to Vercel.

How to Use

Fork the repo on GitHub to create a version of the repository you can deploy where you like.

Edit the linkconfg.json file, and deploy it wherever you like. The one in the repository is used by our website, smoltree.xyz. There are further examples of configurations in the examples directory.

To run it locally, run the following with your favorite package manager (we like pnpm):

pnpm install
pnpm run dev

Configuration

Currently, smol tree can only be configured through the linkconfig.json JSON file, though we may offer more user-friendly ways to do it in the future.

Styles

Configuration uses Tailwind classes for styling.

Icons

Each link can optionally have an icon displayed before it, which is specified in the icon field. The following values are supported:

  • android
  • apple
  • appstore
  • bluesky
  • cashapp
  • discord
  • duolingo
  • farcaster
  • gamepad
  • github
  • googledrive
  • home
  • instagram
  • lastfm
  • linkedin
  • medium
  • npm
  • opensea
  • patreon
  • react
  • reddit
  • spotify
  • steam
  • substack
  • twitch
  • ubisoft
  • wikipedia
  • x
  • youtube