Skip to content

Releases: LinkForty/core

v1.0.0 - Initial Release!

14 Dec 05:49
@onamfc onamfc
v1.0.0
9c5453a

Choose a tag to compare

View all tags
v1.0.0 - Initial Release! Latest
Latest

Release v1.0.0 🎉

This is the first official release of @linkforty/core with automated CI/CD, semantic versioning, and comprehensive testing infrastructure.

What is LinkForty Core?

LinkForty Core is an open-source deeplink management engine that provides smart link routing with device detection, analytics, and UTM parameter support. Built on Fastify with PostgreSQL for persistence and optional Redis for caching.

Features

Smart Linking & Routing

  • QR Code Generation - Generate QR codes for short links with configurable sizes and error correction levels
  • Open Graph Support - Rich social media previews with customizable OG tags
  • Deferred Deep Linking - Probabilistic fingerprint matching for app install attribution
  • Device-Specific URLs - Route users to platform-specific destinations (iOS/Android/Web)

Real-Time Features

  • Event Streaming - Real-time click event broadcasting via WebSocket
  • Live Analytics - Stream click events to connected clients in real-time
  • Event Emitter - Programmatic access to click events for custom integrations

Developer Experience

  • TypeScript First - Full type definitions and type safety
  • Comprehensive API - RESTful endpoints for link management and analytics
  • Testing Routes - Built-in debugging endpoints for link validation
  • Modular Architecture - Use as a complete server or import individual components

Data & Analytics

  • Attribution Windows - Configurable time windows for conversion tracking
  • Click Analytics - Comprehensive tracking with geolocation, device, platform, and referrer data
  • UTM Parameters - Built-in support for campaign tracking
  • Device Detection - Automatic user-agent parsing for platform identification

Getting Started

Installation

npm install @linkforty/core

Quick Start

import { createServer } from '@linkforty/core';

const server = await createServer({
  port: 3000,
  corsOrigin: '*'
});

await server.listen({ port: 3000 });
console.log('Server running on http://localhost:3000');

Docker Deployment

# Clone the repository
git clone https://github.com/linkforty/core.git
cd core/examples

# Start services
docker compose up -d

The API will be available at http://localhost:3000

CI/CD & Automation

This release includes:

  • ✅ Automated testing with Vitest
  • ✅ Code coverage reporting with Codecov
  • ✅ Multi-platform Docker builds (AMD64)
  • ✅ Semantic versioning with conventional commits
  • ✅ Automated releases to NPM and GitHub
  • ✅ Comprehensive GitHub Actions workflows

Changelog

For a detailed list of changes, see CHANGELOG.md.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Full Changelog: https://github.com/linkforty/core/commits/v1.0.0

For issues, questions, or feature requests, please open an issue on GitHub.

Assets 2
Loading