Solelink 🔗

Solelink is the ultimate tool for streamlining your online links and text! With Solelink, you can easily create and deploy a website that showcases your social media profiles, payment providers, and more. Join the Solelink community and revolutionize your online presence.

Read the documentation for detailed instructions.

Table of Contents

• Quick Start
• Features
• Contribution
• Ways to Support Solelink
• License

Quick Start

Prerequisites

• Node.js anything above v14.18.0
• Yarn package manager
• Create a template.toml file and use template.blank.toml as a starting point
• Place your assets in the correct directory. For example, images should go in the src/images folder
• Clone the repository and make it your current working directory

Commands

Install the dependencies

yarn install

Build the app

yarn build

You will now see the files in the "dist" folder.

For more detailed instructions of usage & other features, read the docs.

Features

Back to top

• Static site generation: Solelink allows you to easily create and deploy a static website to popular hosting platforms like Cloudflare Pages and Netlify, which offer free hosting services and do not require a credit card to set up. It is also easy to add a custom domain to your website on these platforms.

• Social media and payment links: Solelink makes it easy to include links to your social media profiles and payment providers, all in one place.

• Easy to use: Solelink uses the TOML configuration file format, which is easy to understand and modify.

• Customizable: Solelink is built with Tailwind and Typescript, making it easy to customize and extend to meet your specific needs.

Contribution

Back to top

Thanks for considering contributing to the Solelink project! We always welcome improvements and contributions from the open-source community. If you'd like to make a contribution, please refer to our Contributing Guide. for more information on how to do so.

Ways to Support Solelink

Back to top

If you want to show your appreciation for Solelink and support its ongoing development, here are a few ways you can help:

• Give the project a star on GitHub
• Talk about solelink on social media
• Recommend it to your friends
• Consider contributing

TODO

Back to top

Here's a couple things I would like to do:

• Fix CSP, stop using unsafe-inline and use hash's instead; Proposed solution, Helpful resource
• Prefetch the CSS; pending vitejs/vite#11484
• Switch to using tailwind defined colors(IE define colors in tailwind.config.cjs)
• Allow user to change tailwind defined colors
• Stop using data uri's(base64 images) and just import them
• allow for qrcodes to be replaced with custom image
• create a plugin to download image urls to the disk
• create a web interface for a more simplified interface, this can come in many forms such as:
  • A config generator, which might have possibility to be interoperable with cf pages
  • A web interface with a backend attached to it to generate assets for the user
  • Take inspiration from Stackblitz's webcontainers and somehow run the vite build process in the browser
• allow for background to be customized with images
• try to reduce the JS to the be the least possible
• Allow for custom themes
• A redesign working with professional designers

License

Back to top

MPL2.