Skip to content

Development phases

Binyamin Yawitz edited this page Apr 3, 2024 · 37 revisions

Linkos (pronounced /leenkos/) deployment will be separated into three phases.

This page will get updated regularly so make sure to check it.

✅ Alpha

The alpha stage will be focused on creating an MVP version of Linkos.

  • Linkos main Dockerfile
  • Development docker-compose.yml file
    • Traefik
    • PostgreSQL
    • ClickHouse
    • Redis
    • Single cluster Kafka + KRaft
    • Linkos endpoint
    • Linkos webhook consumer
    • Linkos analytics consumer
    • Linkos scheduler
  • Linkos API
    • Token Middleware
    • Create a user
    • Token Login
    • Create a short link
    • Delete link
    • Update link
    • Link page details
    • Appwrite Middleware
  • Linkos Dashboard
    • Token Login
    • Appwrite Login
    • Add a short link
    • List of links
    • Delete link
    • Edit link destination and slug
    • Link page with analytics (clicks, QR scans, country, device, top 10 referrers)
    • Move network requests into network helper.
  • Linkos link serving
    • Redirect short link
    • Link to Redis
    • Send analytics to Kafka
  • Linkos worker consumer
    • Save analytics data to ClickHouse
  • Database seeder for generating a huge amount of demo data.
  • Production docker-compose.yml file

⍶ release

  • e2e tests
  • released at 03/11/2024

Beta

The product would be ready to use in the beta stage but not for production environments.

  • Redirect for home empty URL.
  • 404 page
  • Deciding on delete
  • Refactoring
  • Localize
  • Linkos Dashboard
    • General analytics in the dashboard
    • Password reset
    • Campaigns
    • Custom Domains
    • QR Customizer
    • Link options
      • Private
      • Expiration
      • L redirect
      • Plus page
      • Webhooks
      • Targeting device & Geo
      • Tags
      • Monitor
      • UTM Builder
      • Parameter passing
    • CVS Importer
    • Tokens
    • Backups
    • Realtime dashboard in the main dashboard page.
  • Linkos API
    • Dashboard analytics
    • Campaigns
      • 🧪 Test
    • Custom Domains
    • QR Customizer
    • Link options
      • Private
      • Expiration
      • I redirect
      • Plus page
      • Webhooks
      • Targeting device & Geo
      • Tags
      • Monitor
      • Parameter passing
      • 🧪 Test
    • CVS Importer (to Kafka)
      • 🧪 Test
    • Tokens
      • 🧪 Test
    • Backups
      • 🧪 Test
  • Going over // TODO:
  • Level-based access by role
    • 🧪 Test
  • Scheduler
    • Execute goal-oriented webhooks.
  • Analytics Consumer
    • Publish to a soketi channel so it will be available in the dashboard main screen realtime area.
  • Adding documentation.
  • CORS protection for API
  • Quick link add (also through the extension]
  • Chrome extension
    • Default API, short link quick action, go to the dashboard
    • All servers add a link by one and "go to dashboard" for each one
    • Settings, adding server and set as default
  • Optimizing Linkos main Dockerfile

β release

  • e2e tests
  • released at ______

Stable

  • Rate limiter (also for password)
  • Redesign static pages (password, I, Plus, 404)
  • Tests
    • Stress
    • Load
    • Unit
  • k8s Imperative & Declarative files
  • Helm chart
  • Project overview and checking for missing parts.

Notes

Linkos RFC is open and can be found here

Clone this wiki locally