littlelink/README.md

105 lines
7.1 KiB
Markdown
Raw Permalink Normal View History

2024-11-13 01:04:11 -05:00
![Logo](https://cdn.cottle.cloud/GitHub/LittleLink/littlelink.gif)
2019-12-21 22:26:26 -05:00
2023-04-28 13:27:17 -04:00
# LittleLink
2024-03-07 12:00:56 -05:00
The DIY self-hosted LinkTree alternative. LittleLink has more than 100 branded button styles you can easily use, with more regularly added by our community in this repo and in [LittleLink Extended](https://github.com/sethcottle/littlelink-extended).
2019-12-21 22:26:26 -05:00
2024-03-07 12:00:56 -05:00
---
### 🌞 Themes and Accessibility
2024-11-13 01:04:11 -05:00
LittleLink offers `auto`, `light`, and `dark` themes right out of the box. If the default color schemes don't match your preference, you can easily customize them by updating the values in `style.css`. You can set any of the themes right in `index.html`. To enhance visual accessibility in both `light` and `dark` modes, buttons lacking sufficient contrast with the background are outlined with an inverse stroke to ensure visibility. While LittleLink emphasizes accessibility, it's important to acknowledge that not all brands incorporated into LittleLink achieve this standard. Branded buttons that come into LittleLink always retain the original essence of the brand and some branded buttons might fall short of optimal accessibility in terms of contrast.
2019-12-21 22:26:26 -05:00
2024-11-13 01:04:11 -05:00
![Theme](https://cdn.cottle.cloud/GitHub/LittleLink/ThemeSupport.gif)
2019-12-21 22:26:26 -05:00
2024-03-07 10:41:44 -05:00
---
### 🥇 Performance
2024-11-13 01:04:11 -05:00
![Performance](https://cdn.cottle.cloud/GitHub/LittleLink/ranking.gif)
2024-03-07 10:41:44 -05:00
2024-11-13 01:04:11 -05:00
LittleLink epitomizes simplicity and minimalism. When evaluating the [LittleLink sample page](https://littlelink.io/sample/seth) (which mirrors a typical LittleLink setup for an individual) through tools such as [Google PageSpeed Insights](https://pagespeed.web.dev/analysis/https-littlelink-io-sample-seth/17ex80ryq4?form_factor=mobile), showcases LittleLink's excellence with 100/100 in Performance, Accessibility, Best Practices, and SEO. My initial vision for LittleLink was to craft it from the fundamentals. LittleLink leverages it's own vanilla `css` to remove the unnecessary bloat you would get from using a large framework for a page that requires nothing more than simplicity.
2019-12-21 22:26:26 -05:00
2024-03-07 10:41:44 -05:00
---
### ☁️ Deploy
2024-11-13 01:04:11 -05:00
![Publish](https://cdn.cottle.cloud/GitHub/LittleLink/test/css/deploy.gif)
2019-12-21 22:26:26 -05:00
2024-03-07 10:47:56 -05:00
No need for gulp, npm, or anything else to make LittleLink work—it uses the bare essentials. You can automatically fork and deploy LittleLink with [Vercel](https://vercel.com/), [Netlify](https://www.netlify.com/), or [Amplify](https://aws.amazon.com/amplify) using the button below. LittleLink is also easy to host through [GitHub Pages](https://pages.github.com/) or on your home lab server, CDN, or other frontend hosting services. To edit, all you need is a little basic HTML knowledge to add a link to the exisiting buttons or you can create your own. See our [adding custom buttons to your own fork wiki](https://github.com/sethcottle/littlelink/wiki/Adding-custom-buttons-to-your-own-fork). It's simple, promise. 🤞
2019-12-21 22:26:26 -05:00
2024-03-07 10:41:44 -05:00
---
2024-03-07 11:28:32 -05:00
##### One-Click Deployments
2023-04-30 11:00:21 -04:00
[![Deploy to Vercel](https://cdn.cottle.cloud/littlelink/button-deploy-vercel.svg)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsethcottle%2Flittlelink&project-name=littlelink&repository-name=littlelink)
2023-04-30 11:00:21 -04:00
2024-03-06 23:14:27 -05:00
[![Deploy to Netlify](https://cdn.cottle.cloud/littlelink/button-deploy-netlify.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/sethcottle/littlelink)
2023-04-30 11:00:21 -04:00
[![Deploy to Amplify](https://cdn.cottle.cloud/littlelink/button-deploy-amplify.svg)](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/sethcottle/littlelink)
---
2024-03-07 10:41:44 -05:00
### 🤝 Contributions
2024-03-06 23:13:42 -05:00
Please reference the [submitting a new brand to LittleLink wiki](https://github.com/sethcottle/littlelink/wiki/Submitting-a-new-brand-to-LittleLink) before opening a PR.
---
2024-03-07 10:41:44 -05:00
### 📦 Community Extras
2024-03-07 10:41:44 -05:00
#### 🛸 LittleLink Extended
2024-03-07 12:00:56 -05:00
Looking for more niche services to add to your copy of LittleLink? Check out [LittleLink Extended](https://github.com/sethcottle/littlelink-extended). Users can add more niche services to this repository to help keep the core LittleLink repository less cluttered and more focused on delivering branded experiences for the majority of users.
#### 🎨 Figma
Duplicate the [LittleLink Template on Figma Community](https://www.figma.com/community/file/846568099968305613) to help plan out and design your LittleLink page.
2023-07-06 16:04:37 -04:00
[![Figma Community](https://cdn.cottle.cloud/littlelink/button-figma-community.svg)](https://www.figma.com/community/file/846568099968305613)
#### 🐋 Docker
2023-07-06 16:04:37 -04:00
• [Techno Tim](https://github.com/timothystewart6) is building [LittleLink-Server](https://github.com/techno-tim/littlelink-server). Check out [his video](https://youtu.be/42SqfI_AjXU)!
2023-07-06 16:04:37 -04:00
• [Drew](https://github.com/davisdre) is building a [super simple Docker implementation of LittleLink](https://github.com/davisdre/littlelink).
2021-10-04 10:27:27 -04:00
#### 🗃️ Misc
2024-11-13 01:04:11 -05:00
• [Julian](https://github.com/JulianPrieber) is building [LinkStack](https://github.com/LinkStackOrg/LinkStack), which is a fork of [Khashayar](https://github.com/khashayarzavosh)'s [LittleLink Admin](https://github.com/khashayarzavosh/admin-littlelink).
2021-12-14 14:18:49 -05:00
---
### 💖 Supporters
2023-07-06 16:04:37 -04:00
You can support LittleLink by [buying me a coffee](https://www.buymeacoffee.com/seth). You can also have your name or your company added to this section and the supporters page of the [LittleLink.io](https://littlelink.io) website.
2022-03-12 14:36:08 -05:00
#### 🏢 Business Supporters
2023-07-06 16:04:37 -04:00
**[links.dev](https://github.com/fatih-yavuz/links.dev)**
2023-06-16 12:31:37 -04:00
2023-07-06 16:04:37 -04:00
[![Add Your Company Name](https://cdn.cottle.cloud/littlelink/button-buy-me-a-coffee-company.svg)](https://www.buymeacoffee.com/seth/e/50574)
#### ✨ Individual Supporters
2023-07-06 16:04:37 -04:00
**[Drew Davis](https://connect.davisdre.me)**
**[Robotter112](https://robotter112.de/)**
[![Buy Me A Coffee](https://cdn.cottle.cloud/littlelink/button-buy-me-a-coffee-individual.svg)](https://www.buymeacoffee.com/seth/e/50573)
#### 🐙 GitHub Sponsors
**[Your Name Here](https://github.com/sponsors/sethcottle)**
[![GitHub Sponsors](https://cdn.cottle.cloud/littlelink/button-github-sponsors.svg)](https://github.com/sponsors/sethcottle)
#### ❤️ Patreon Members
**[Your Name Here](https://www.patreon.com/sethcottle)**
[![Patreon](https://cdn.cottle.cloud/littlelink/button-patreon.svg)](https://www.patreon.com/sethcottle)
#### 🥰 More Ways to Support LittleLink
[![Buy Me A Coffee](https://cdn.cottle.cloud/littlelink/button-buy-me-a-coffee.svg)](https://www.buymeacoffee.com/seth/)
2023-07-06 16:04:37 -04:00
[![Ko-Fi](https://cdn.cottle.cloud/littlelink/button-ko-fi.svg)](https://ko-fi.com/sethcottle)
2022-05-03 15:28:51 -04:00
2023-07-06 16:04:37 -04:00
[![PayPal](https://cdn.cottle.cloud/littlelink/button-paypal.svg)](https://paypal.me/sethcottle/)
---
### 📊 Analytics
2023-04-28 09:58:31 -04:00
To help build a more privacy focused product, we recommend using [Fathom Analytics](https://usefathom.com/ref/EQVZMV)*. [View our Fathom analytics dashboard](https://app.usefathom.com/share/xbmnwxxl/littlelink.io#/?filters=%5B%5D&range=last_7_days&site=2251799827005303)**.
###### * This is a referral link. Using this link to sign up for Fathom is an easy way to help support LittleLink!
2023-04-28 09:58:31 -04:00
###### ** Analytics in this dashboard start May 03, 2022. View this [Google Sheets file](https://docs.google.com/spreadsheets/d/1GL4SroAdH-OZphBVR5z-BoSukHIEVJfao25q_e9-Ii8/edit?usp=sharing) with the generic unique pageview data from Google Analytics.
2024-03-07 12:00:56 -05:00
[![Fathom](https://cdn.cottle.cloud/littlelink/button-fathom-analytics.svg)](https://usefathom.com/ref/EQVZMV)