Singlelink

SingleLink est l'alternative à linktree open-source.

Démarrage • Développement local • Déploiement de la production • Crédits

Commencer

La façon la plus simple de commencer est de déployer votre site de Singlelink avec Railway. Vous pouvez commencer avec un clic en utilisant le bouton ci-dessous et construire jusqu'à trois pages Singlelink, chacune avec des domaines personnalisés, 100% gratuits, grâce à leur système de crédit de 5 $ / mois.

Nous recommandons également de connecter Vercel et PlanetScale pour un environnement SingleLink auto-hébergé gratuit.

Développement local

SingleLink est un projet NodeJS construit sur Next.js, GraphQL (servi via Apollo Server) et MySQL.

Si vous ne l'avez pas déjà fait, vous devrez installer NodeJS et MySQL avant de pouvoir héberger ou travailler sur SingeLink.

• Guide d'installation de NodeJS
• Pour installer MySQL avec Docker, exécutez npm run db:boot à partir de la racine du projet.

Une fois que vous avez installé Nodejs et MySQL, vous pouvez télécharger SingleLink localement avec:

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

Avant de commencer, vous devrez configurer votre environnement en copiant le modèle .env:

 cp .env.template .env

Ensuite, définissez les variables d'environnement obligatoires suivantes sur vos préférences:

• DB_URL : éventuellement, remplacer les variables DB ENV restantes avec une URL de connexion tout-en-un
• DB_DATABASE : Le nom de la base de données MySQL à laquelle vous vous connectera (Ex: Railway)
• DB_PORT : Le port de la base de données MySQL à laquelle vous vous connectera (Ex: 3306)
• DB_HOST : L'URL de l'hôte pour votre base de données MySQL (Ex: conteneurs-US-East-13.Railway.App)
• DB_USER : le nom d'utilisateur de votre utilisateur MySQL (ex: root)
• DB_PASSWORD : Le mot de passe de votre utilisateur MySQL
• SECRET : le secret utilisé pour signer et valider les JWT pendant l'authentification
• PASSWORD : le mot de passe que vous utiliserez pour vous connecter et gérer votre singlelink

Facultativement, définissez les variables suivantes pour personnaliser votre site:

• META_TITLE : le titre de votre site, vu dans les résultats de recherche Google
• META_DESC : La description de votre site, vu dans les résultats de la recherche Google
• META_IMG : L'image OG de votre site, vu lors du partage de votre site sur les réseaux sociaux.
• BRANDING : un booléen qui permet / désactive la marque Singlelink sur votre site et tableau de bord

Ensuite, installez vos dépendances NPM en utilisant --ignore-scripts :

npm i --ignore-scripts

Après, vous pouvez exécuter le script de migration DB pour initialiser votre base de données:

npm run db:migrate

Vous devrez exécuter npm run db:migrate à nouveau à chaque fois que vous tirez des modifications. Cela ne peut pas faire de mal de faire une migration, mais cela peut casser les choses si vous ne le faites pas.

Enfin, vous pouvez démarrer votre environnement de développement en fonctionnant:

npm run dev

Ouvrez http: // localhost: 3000 avec votre navigateur pour afficher votre nouveau SingleLink, et http: // localhost: 3000 / connecter pour vous connecter et ajouter votre premier lien.

Déploiement de la production

Vous pouvez déployer Singlelink en un clic ici avec Railway. À l'heure actuelle, ils sont le seul fournisseur que nous maintenons et le soutien gurantee.

Besoin d'héberger ailleurs?

La plate-forme en tant qu'hôtes de service est recommandée en raison de la facilité d'installation (Ex: Heroku, plate-forme d'application DigitalOcean, etc.)

Nous n'offrons pas encore le support officiel, mais vous pouvez héberger SingleLink avec n'importe quel VPS, à condition que vous puissiez installer et exécuter Node.js et MySQL. SingleLink aura besoin d'une base de données MySQL et d'une instance NodeJS capable d'exécuter Next.js à l'exécution / ssr.

Vous cherchez l'hébergement cloud avec un support premium?
Pensez à consulter Singlelink Cloud, avec des plans disponibles bientôt à partir de seulement 8 $ / mois.

Crédits

Singlelink a été construit par l'équipe suivante à temps plein d'août 2020-2021 Notre mission d' ouvrir l'ouverture du monde chez Neutron Creative.

• Jim Bisenius (co-fondateur et ancien PDG, @jim_bisenius)
• Navid Kabir (co-fondateur et ancien CTO, @ NAVIDK0)
• Andrew Boyle (co-fondateur et ancien CMO)

Aujourd'hui, Singlelink est maintenu Soley par moi, Jim Bisenius les nuits et les week-ends. Si vous souhaitez aider mes efforts de développement, j'aimerais votre aide. Veuillez rejoindre notre discorde ou créer une demande de traction!