Skip to content

klixsoft/worklyn

Repository files navigation

Worklyn Logo

Worklyn

Open-source project management platform built for modern engineering teams.

License: MIT Next.js FastAPI Docker PRs Welcome

Demo · Documentation · Report a Bug · Request a Feature


✨ Overview

Worklyn is a self-hostable, multi-module workspace platform that brings project management, team communication, attendance tracking, and role-based access control into one cohesive interface — powered by a Next.js frontend and a FastAPI backend.

Key Features

Feature Description
🗂 Kanban Boards Drag-and-drop project boards with custom columns and task assignment
💬 Team Chat Real-time channels, group chats, and direct messages per project
📊 Analytics Dashboard Live charts — task distribution, project velocity, team workload
🕐 Attendance Tracking Clock-in / clock-out with daily standup logs
👥 User & Role Management Dynamic roles with granular per-module permission control
🧩 Multi-Software Switcher Switch between PM, Finance, and HR modules from the sidebar
🌗 Dark / Light Mode System-aware theming with instant toggle

🛠 Tech Stack

Frontend

Backend

  • FastAPI — High-performance async API framework
  • uvicorn — Lightning-fast ASGI server
  • uv — Ultra-fast Python package manager

Infrastructure

  • Docker + Docker Compose — Containerised, one-command deployment

🚀 Quick Start

Prerequisites

Run with Docker

# Clone the repository
git clone https://github.com/klixsoft/worklyn.git
cd worklyn

# Start all services
docker-compose up --build
Service URL
Frontend (Next.js) http://localhost:3000
Backend (FastAPI) http://localhost:8000
API Docs (Swagger) http://localhost:8000/docs

Local Development

Frontend

cd frontend
npm install
npm run dev        # http://localhost:3000

Backend

cd backend
uv sync            # install dependencies
uv run uvicorn main:app --reload   # http://localhost:8000

📁 Project Structure

worklyn/
├── frontend/                 # Next.js application
│   ├── app/                  # App Router pages & layouts
│   ├── components/           # Reusable UI components
│   │   ├── ui/               # shadcn/ui primitives
│   │   ├── sidebar.tsx       # Navigation sidebar
│   │   └── dashboard.tsx     # Analytics dashboard
│   └── Dockerfile
│
├── backend/                  # FastAPI application
│   ├── main.py               # App entry point & routes
│   ├── pyproject.toml        # Python dependencies
│   └── Dockerfile
│
├── docker/                   # Docker entrypoint scripts
│   ├── frontend/entrypoint.sh
│   └── backend/entrypoint.sh
│
├── docker-compose.yml        # Compose orchestration
├── LICENSE                   # MIT License
└── README.md

🤝 Contributing

We love contributions! Please read our Contributing Guide to get started.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feat/my-feature)
  3. Commit your changes (git commit -m 'feat: add my feature')
  4. Push to the branch (git push origin feat/my-feature)
  5. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.


🔒 Security

If you discover a security vulnerability, please read our Security Policy before disclosing it publicly.


📄 License

Worklyn is open-source software licensed under the MIT License.


Made with ❤️ by Klixsoft and the open-source community.

About

Worklyn is a self-hostable, multi-module workspace platform that brings project management, team communication, attendance tracking, and role-based access control into one cohesive interface — powered by a Next.js frontend and a FastAPI backend.

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors