LinkX – Open Source Social Posting & Scheduling

LinkX is an open‑source social media planner that you can self‑host with Docker Compose. It gives you a unified dashboard to draft, schedule, and publish posts across platforms while you retain full control of your data and infrastructure.

Technology Stack and Features

• ⚡ FastAPI backend API.
  • 🧰 SQLModel ORM over PostgreSQL.
  • 🔍 Pydantic for data validation and settings.
  • 💾 PostgreSQL as the database.
• 🚀 React frontend.
  • TypeScript, hooks, Vite, and modern tooling.
  • 🎨 Tailwind CSS + shadcn/ui components.
  • 🧪 Playwright for end‑to‑end testing.
  • 🦇 Built‑in dark mode support.
• 🐋 Docker Compose for local and production deployments.
• 🔒 Secure password hashing and JWT authentication.
• 📫 Email‑based password recovery with Mailcatcher in development.
• ✅ Tests with Pytest.
• 📞 Traefik reverse proxy / load balancer (optional layouts).
• 🚢 Deployment docs for running LinkX as your own self‑hosted social scheduler.

Social Integrations (LinkX)

• LinkedIn member posting (self‑hosted):
  • Connect a personal LinkedIn account and publish or delete posts directly from LinkX.
  • Uses OAuth 2.0 with scopes openid profile email w_member_social.
  • Tokens are stored server‑side only in your deployment; no secrets are exposed to the browser.
  • See docs/LINKEDIN_SETUP.md for step‑by‑step configuration.
• Planned:
  • X (Twitter) integration.
  • Richer media workflows and cross‑posting, tracked in docs/specs/SOCIAL_MEDIA_INTEGRATION.md and related specs.

Screenshots

Captured from the app running locally (bun run dev in frontend/, dark theme): sign-in, home timeline, posts, and social personas.

Quick start

git clone git@github.com:AchuAshwath/LinkX.git
cd LinkX
# Create and edit `.env` at the repo root (see development.md / deployment.md).

Typical local setup (see AGENTS.md and development.md for details):

• Backend: docker compose watch backend
• Frontend: cd frontend && bun install && bun run dev

Configure secrets in .env (SECRET_KEY, FIRST_SUPERUSER_PASSWORD, POSTGRES_PASSWORD, etc.) before a real deployment.

Generate secret keys

python -c "import secrets; print(secrets.token_urlsafe(32))"

Documentation

Topic	Location
Backend	backend/README.md
Frontend	frontend/README.md
Deployment	deployment.md
Local dev & tooling	development.md
Agent / AI guidelines	AGENTS.md

Longer template-derived release notes (historical) live in release-notes.md.

Sponsor

If LinkX is useful to you, sponsorship helps maintain and grow the project:

github.com/sponsors/AchuAshwath

The Sponsor button on this repository is configured via .github/FUNDING.yml.

Acknowledgments

LinkX builds on patterns and code from the FastAPI full-stack template and related ecosystem projects (MIT License). LinkX-specific features (personas, teams, LinkedIn integration, and social UI) are developed in this repository.

License

See LICENSE (MIT).