Singlelink is the open-source micro-site platform & Linktree alternative.
Get started • Development • Deployment • Credits • Support • Related • License
There are a few pre-requisites you need to have before hosting Singlelink, seen below.
- Two NodeJS servers (ex: $5/mo DigitalOcean Droplet)
- A PostgreSQL database (ex: Free Heroku DBaaS)
Once you have the following established, it's time to begin installing & configuring your installation.
# Clone repostiory to local device
git clone https://github.com/Neutron-Creative/Singlelink.git
# Enter client of new project
cd Singlelink/client
# Install necessary dependencies
npm install
# Set API Url
export API_URL=<your-api-url>
# Optionally, customize your instance.
# You can also set these permanently via the .env file
export META_TITLE=<your-seo-meta-title>
export META_DESCRIPTION=<your-seo-meta-description>
export META_IMAGE=<your-meta-image>
export FAVICON=<your-favicon-url>
export HOSTNAME=<your-installation-hostname>
export APP_NAME=<your-app-name>
export ICON_URL=<your-icon-url>
export ICON_WIDTH=<your-icon-width>
export ORGANIZATION=<your-organization>
export FREE_SIGNUP=<is-freesignup-enabled>
# Run first build
npm run build
# Start your server
npm run start
# Clone repostiory to local device (don't need to repeat if performed previously for client)
git clone https://github.com/Neutron-Creative/Singlelink.git
# Enter client of new project
cd Singlelink/server
# Install necessary dependencies
npm install
# Generate config from example
cp src/config.example.js src/config.js
# Modify config.js (set API domain to localhost & client domain as neccessary)
vim config.js
# Build server
npm run build
# Start your server
npm run startDevelop on the client if you're looking to make changes to the interface or styles of the application.
Note, pay attention to the notice below. You'll need to build & start the client before each usage to have your changes reflect properly in the application.
## CD into Client
cd Singlelink/client
# Run developer client
npm run dev
Develop on the server if you're looking to make changes to the logic of the application.
Developing on the server is a bit simpler, in that there is no "rebuild" process. With nodemon, changes are reloaded live instantaneously.
## CD into Server
cd Singlelink/server
# Run developer server
npm run devUse the following instructions for deploying changes made locally to your production servers.
Note, before following the next steps - ensure you have pushed all changes to the git master branch!
# SSH into server
ssh root@<your-server-ip>
# Enter tmux session (if first time then tmux && cd Singlelink)
tmux attach
# Pull latest changes from git, install dependencies, rebuild, and restart the server
git pull;npm i;npm run build;npm run start;
# Exit tmux session
# Not to be typed, press both keys simultaneously
# Ctrl + b
# Afterwhich, press the following key
# d
# Exit server, changes are deployed!
# SSH into server
ssh root@<your-server-ip>
# Enter correct directory
cd ~/Singlelink/server/
# Pull latest changes from git, install dependencies, rebuild, and restart the server
git pull;npm i;npm run build;npm run start;
# Exit server, changes are deployed!
Singlelink was built by the following individuals.
- Jim Bisenius (@jim_bisenius)
- Andrew Boyle (@fahlomi)
- Navid Kabir (@navidk0)
- Manuhe Abebe (@manuhegabebe)
Additionally, we've listed a few frequently asked questions below.
Often, this is caused by an incomplete config.js file in Singlelink/server/config.js, be sure this is complete!
This is most often caused by an incomplete/incorrect build, with missing environment variables or something of the like. To fix, ensure that the $API_URL environment variable is properly set on your client server, and run npm run build inside your client directory to manually rebuild the project.
Unfortunately, we discontinued static platform support in late 2020 when moving to v2.0 to gain features such as dynamic open-graph images, search engine optimization, alongside custom meta data.
Check our roadmap! We're regularly adding new features, and list our most up-to-date plans on Github.
Yes! As of January 2020, you can reach out to [email protected] and we'll be glad to help you get set up (incurs $100 install + $35/mo hosting fees). We offer full installation, management, and maintenance services for Enterprise clients starting at just $35/mo.
The Github issue tracker is the best place to do that! No matter your experience & ability creating Github issues, this is the best way for us to see & respond quickly to your requests.
Yes! We're actively daily on Discord and would love to have you!
