Upstream/littlelink-server
1
0
Fork 0
mirror of https://github.com/techno-tim/littlelink-server.git synced 2024-11-22 05:25:13 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
A lightweight, open source, stateless, and self-hosted alternative to linktree in a Docker container!
15 Commits 1 Branch 0 Tags 10 MiB
JavaScript 75.5%
CSS 24%
Dockerfile 0.5%
4f2e0246ee
Go to file
Timothy Stewart 4f2e0246ee docs(README): adding examples
2021-08-10 22:35:59 -05:00
.github chore(CI): Switching to GHCR 2021-08-09 22:58:36 -05:00
www feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
.editorconfig feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
.gitignore feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
.nvmrc feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
app.js feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
docker-compose.yml feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
Dockerfile docs(README): adding examples 2021-08-10 22:35:59 -05:00
entrypoint.sh feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
package.json feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00
README.md docs(README): adding examples 2021-08-10 22:35:59 -05:00
yarn.lock feat(init): ⚡initial commit 2021-08-09 21:58:26 -05:00

README.md

🔗 LittleLink-Server

This project is based on the great work from littlelink It takes the same simple approach to a link page and hosts it within a nodeJS server containerized for you to use. Now, customizing LittleLink with littlelink-server is as easy as passing in some environment variables.

👇 What is LittleLink?

LittleLink

LittleLink is a lightweight DIY alternative to services like Linktree and many.link. LittleLink was built using Skeleton, a dead simple, responsive boilerplate—we just stripped out some additional code you wouldn't need and added in branded styles for popular services. 😊

Themes

LittleLink has more than 20 company button styles you can use and we'll be throwing more in soon. You'll also find a light and dark theme ready to go. Not a fan of the colors? Update skeleton-light.css or skeleton-dark.css to the HEX values of your choosing.

Performance

Using Skeleton let us build something that loads quickly & doesn't have any of the unnecessary bloat you would get from using a large framework for a page that requires nothing more than simplicity. LittleLink scored a 99/100 in performance when tested with Google Lighthouse.

Getting Started

docker-compose.yml

---
version: '3'
services:
  little-link:
    image: ghcr.io/techno-tim/littlelink-server:latest
    container_name: littlelink-server
   volumes:
     - ./www:/usr/src/app
    environment:
      - META_TITLE=Techno Tim
      - META_DESCRIPTION=Techno Tim Link page
      - META_AUTHOR=Techno Tim
      - THEME=Dark
      - FAVICON_URL=https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_400x400.jpg
      - AVATAR_URL=https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_400x400.jpg
      - AVATAR_ALT=Techno Tim Profile Pic
      - NAME=TechnoTim
      - BIO=Hey! Just a place where you can connect with me!
      - GITHUB=https://github.com/timothystewart6
      - TWITTER=https://twitter.com/TechnoTimLive
      - INSTAGRAM=https://www.instagram.com/techno.tim
      - YOUTUBE=https://www.youtube.com/channel/UCOk-gHyjcWZNj3Br4oxwh0A/
      - TWITCH=https://www.twitch.tv/technotim/
      - DISCORD=https://discord.gg/DJKexrJ
      - KIT=https://kit.co/TechnoTim
      - FOOTER=Thanks for stopping by!

    ports:
      - 8080:3000
    restart: unless-stopped
    security_opt:
      - no-new-privileges:true