Skip to content

Latest commit

 

History

History
106 lines (84 loc) · 8.25 KB

readme.md

File metadata and controls

106 lines (84 loc) · 8.25 KB
Raw

Singlelink logo

Singlelink is the open-source Linktree alternative.

Version License Users

Twitter Follow

Deploy a Singlelink page • Local development • Credits

Deploy a Singlelink page

The easiest way to self-host your own Singlelink site is with Railway.
With Railway, you can set up a Singlelink page with a custom domain, with no tracking, no ads, and run up to three sites 100% free, since Railway provides $5 in free monthly credits and each Singlelink instance costs ~$1.54/mo.

Deploy on Railway

If you don't wanto to host with Railway, you can host Singlelink with any host, provided you can install and run both Node.JS & PostgreSQL. Singlelink will need one PostgreSQL database, and one NodeJS instance capable of running Next.JS at run-time/SSR.

Looking for a hands-off experience with premium support?
Consider checking out Singlelink Cloud, with plans starting at just $5/month.

Local development

Singlelink is a NodeJS project built on Next.js, GraphQL (served via Apollo Server), and PostgreSQL.

If you haven't already, you'll need to install NodeJS and PostgreSQL before being able to host or work on Singelink.

Once you've installed NodeJS & PostgreSQL, you can download Singlelink locally with:

git clone https://github.com/Neutron-Creative/Singlelink.git;cd Singlelink;

Before you start, you'll need to configure your environment by copying the .env template:

cp .env.template .env

Then, set the following mandatory environment variables to your preferences:

  • PGDATABASE: The name of the postgres database you'll connect to (ex: railway)
  • PGPORT: The port for the postgres database you'll connect to (ex: 7612)
  • PGHOST: The host url for your postgres database (ex: containers-us-east-13.railway.app)
  • PGUSER: The username for your postgres user (ex: postgres)
  • PGPASSWORD: The password for your postgres user
  • SECRET: The secret used to sign and validate JWTs during authentication
  • PASSWORD: The password you'll use to login and manage your Singlelink

Optionally, set the following variables to customize your site:

  • META_TITLE: The title for your site, seen in Google Search results
  • META_DESC: The description for your site, seen in Google Search results
  • META_IMG: The OG image for your site, seen when sharing your site on social media.
  • BRANDING: A boolean that enables/disables Singlelink branding on your site & dashboard

Next, install your dependencies, which will also run your first-time database migration after:

npm i

Finally, you can start your development environment by running:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Credits

Singlelink was built by the following team full-time from August 2020-2021 our mission to to open-source the world at Neutron Creative.

  • Jim Bisenius (Co-founder & former CEO, @jim_bisenius)
  • Navid Kabir (Co-founder & former CTO, @navidk0)
  • Andrew Boyle (Co-founder & former CMO)

Today, Singlelink is maintained soley by me, Jim Bisenius on nights & weekends. If you'd like to assist in my development efforts, I'd love your help. Please join our Discord or create a pull request!