Skip to content

local-development.md

Latest commit

 

History

History
144 lines (107 loc) · 2.98 KB

local-development.md

File metadata and controls

144 lines (107 loc) · 2.98 KB

Self-hosting Guide

Warning

This guide is currently a work in progress.

This guide will help you get Linky running locally. Follow these steps to get your instance up and running.

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js (version specified in .nvmrc)
  • Docker and Docker Compose
  • PostgreSQL 15.1 or later
  • Git

Step 1: Clone the repository

git clone https://github.com/trylinky/linky.git
cd linky

Step 2: Environment Setup

  1. Copy the example environment file:
cp .env.example .env.local
  1. Fill in the required environment variables in .env.local (please see the env file for more details on what is required and what the variables are for).

Third-party Services

You'll need to set up the following services and add their credentials:

Required Services

  • AWS (for asset storage):
    • AWS_ACCESS_KEY_ID
    • AWS_SECRET_ACCESS_KEY
    • AWS_REGION
  • Google OAuth:
    • AUTH_GOOGLE_CLIENT_ID
    • AUTH_GOOGLE_CLIENT_SECRET
  • Twitter (X) OAuth:
    • AUTH_TWITTER_CLIENT_ID
    • AUTH_TWITTER_CLIENT_SECRET
  • TikTok OAuth:
    • AUTH_TIKTOK_CLIENT_ID
    • AUTH_TIKTOK_CLIENT_SECRET
  • Stripe (for payments):
    • STRIPE_API_SECRET_KEY
    • STRIPE_WEBHOOK_SECRET
  • Sentry (for error tracking):
    • NEXT_PUBLIC_SENTRY_DSN
    • SENTRY_AUTH_TOKEN
  • Tinybird (for analytics):
    • NEXT_PUBLIC_TINYBIRD_TRACKER_TOKEN
    • TINYBIRD_API_KEY
  • Posthog (for analytics):
    • POSTHOG_API_KEY
  • DynamoDB (for reactions storage):
    • REACTIONS_TABLE_NAME
  • Slack (for notifications):
    • SLACK_TOKEN

Integrations

  • Instagram Integration:
    • INSTAGRAM_CALLBACK_URL
    • INSTAGRAM_CLIENT_ID
    • INSTAGRAM_CLIENT_SECRET
  • Spotify:
    • SPOTIFY_CLIENT_ID
    • SPOTIFY_CLIENT_SECRET
    • SPOTIFY_REDIRECT_URL
  • Threads:
    • THREADS_CALLBACK_URL
    • THREADS_CLIENT_ID
    • THREADS_CLIENT_SECRET
  • TikTok:
    • TIKTOK_CALLBACK_URL
    • TIKTOK_CLIENT_KEY
    • TIKTOK_CLIENT_SECRET

Step 3: Database Setup

  1. Start the PostgreSQL database using Docker Compose:
docker-compose up -d
  1. The database will be bootstrapped with the following default credentials:
    • Username: glow_user
    • Password: KGfUZosCOm
    • Database: glow_development

Step 4: Installation

  1. Install dependencies:
npm install
  1. Generate Prisma client:
cd package.prisma
npx prisma generate
  1. Run database migrations:
npm run dev:migrate

Step 5: Building the Application

Build all packages and applications:

turbo dev

Turbo will start the API and the frontend application on the following ports:

Security Considerations

  1. Always use HTTPS in production
  2. Keep your ENCRYPTION_KEY secure and never share it
  3. Regularly update dependencies for security patches
  4. Use strong passwords for all services

License

Make sure you comply with the project's license terms when self-hosting.