{"id":44085974,"url":"https://github.com/doxynix/doxynix","last_synced_at":"2026-05-30T01:04:15.973Z","repository":{"id":329835906,"uuid":"1120283511","full_name":"doxynix/doxynix","owner":"doxynix","description":"Turn your code into insights. Automatic analysis, quality metrics, and documentation generation for GitHub repositories.","archived":false,"fork":false,"pushed_at":"2026-05-02T06:18:48.000Z","size":7013,"stargazers_count":3,"open_issues_count":12,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-02T08:37:08.903Z","etag":null,"topics":["documentation","doxynix","generator","nextjs","prisma","react","tailwindcss","trpc","typescript","zod"],"latest_commit_sha":null,"homepage":"https://doxynix.space","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doxynix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-12-20T21:48:02.000Z","updated_at":"2026-05-02T06:18:31.000Z","dependencies_parsed_at":"2026-03-09T12:06:52.878Z","dependency_job_id":"6db17173-a0aa-471b-815b-5a9928b3ef07","html_url":"https://github.com/doxynix/doxynix","commit_stats":null,"previous_names":["kramqx/diploma-proj","kramqx/doxynix"],"tags_count":193,"template":false,"template_full_name":null,"purl":"pkg:github/doxynix/doxynix","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doxynix%2Fdoxynix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doxynix%2Fdoxynix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doxynix%2Fdoxynix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doxynix%2Fdoxynix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doxynix","download_url":"https://codeload.github.com/doxynix/doxynix/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doxynix%2Fdoxynix/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32640538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","doxynix","generator","nextjs","prisma","react","tailwindcss","trpc","typescript","zod"],"created_at":"2026-02-08T10:04:52.644Z","updated_at":"2026-05-05T08:01:47.965Z","avatar_url":"https://github.com/doxynix.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n***\n\n# ⚡ Doxynix\n\n\u003cdiv align=\"center\"\u003e\n\n\u003c!-- Status Badges --\u003e\n[![CI Status](https://img.shields.io/github/actions/workflow/status/doxynix/doxynix/ci.yml?style=for-the-badge\u0026logo=github-actions\u0026label=CI%20Pipeline)](https://github.com/doxynix/doxynix/actions)\n[![Security: CodeQL](https://img.shields.io/github/actions/workflow/status/doxynix/doxynix/codeql.yml?style=for-the-badge\u0026logo=github-security\u0026label=CodeQL\u0026color=blue)](https://github.com/doxynix/doxynix/actions)\n[![Website Status](https://img.shields.io/website?url=https%3A%2F%2Fdoxynix.space\u0026style=for-the-badge\u0026logo=vercel\u0026label=System%20Status\u0026up_message=Operational\u0026down_message=Downtime\u0026up_color=success\u0026down_color=red)](https://doxynix.space)\n\n\u003c!-- Core Stack Badges --\u003e\n![Next.js](https://img.shields.io/badge/Next.js-16.1-black?style=for-the-badge\u0026logo=next.js\u0026logoColor=white)\n![React](https://img.shields.io/badge/React-19-61DAFB?style=for-the-badge\u0026logo=react\u0026logoColor=black)\n![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178C6?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![TailwindCSS](https://img.shields.io/badge/Tailwind_v4-38B2AC?style=for-the-badge\u0026logo=tailwind-css\u0026logoColor=white)\n\n\u003c!-- Backend \u0026 Tools Badges --\u003e\n![tRPC](https://img.shields.io/badge/tRPC-v11-2596BE?style=for-the-badge\u0026logo=trpc\u0026logoColor=white)\n![Prisma](https://img.shields.io/badge/Prisma-ORM-2D3748?style=for-the-badge\u0026logo=prisma\u0026logoColor=white)\n![Zod](https://img.shields.io/badge/Zod-Validation-3068b7?style=for-the-badge\u0026logo=zod\u0026logoColor=white)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?style=for-the-badge\u0026logo=conventionalcommits\u0026logoColor=white)](https://conventionalcommits.org)\n[![RelativeCI](https://badges.relative-ci.com/badges/pSyX3AJ3lNJwWJIvB8qs?branch=main\u0026style=flat-square)](https://app.relative-ci.com/projects/pSyX3AJ3lNJwWJIvB8qs)\n[![codecov](https://codecov.io/gh/doxynix/doxynix/graph/badge.svg?token=6JIP6IY9CB)](https://codecov.io/gh/doxynix/doxynix)\n\n\u003c!-- Header Content --\u003e\n\u003ch3\u003eRepository Analysis \u0026 Documentation Generator Service\u003c/h3\u003e\n\u003cp\u003eTurn your code into insights. Automatic analysis, quality metrics, and documentation generation for GitHub repositories.\u003c/p\u003e\n\n[View Demo](https://doxynix.space) · [Report Bug](https://github.com/doxynix/doxynix/issues) · [Request Feature](https://github.com/doxynix/doxynix/issues)\n\n\u003c/div\u003e\n\n---\n\n## 🚀 About The Project\n\n**Doxynix** is an enterprise-grade web application designed to help developers understand complex codebases. It leverages static analysis to calculate complexity metrics, track technical debt, and generate comprehensive documentation automatically.\n\nEngineered with extreme attention to performance and type safety, Doxynix utilizes the bleeding-edge **Next.js 16** stack with **Partial Prerendering (PPR)** to deliver a native-like experience.\n\n### Key Features\n*   📊 **Deep Static Analysis:** powered by custom parsers and `jscpd` for copy-paste detection.\n*   ⚡ **Zero-Latency UI:** Utilizing `TanStack Query` and `PPR` for instant state management.\n*   🔒 **Enterprise Security:** `NextAuth.js` with GitHub OAuth, secured by `Secretlint` and `CodeQL`.\n*   📄 **Auto-Docs:** `tRPC` to OpenAPI generation via `Scalar`.\n*   ☁️ **Serverless Infrastructure:** Database on Neon (Pg), queues on Upstash, files on UploadThing.\n\n---\n\n## 🛠️ Tech Stack\n\n### Frontend \u0026 UI\n| Technology | Version | Usage |\n| :--- | :--- | :--- |\n| **Next.js** | `16.1.0` | App Router, Server Actions, PPR. |\n| **React** | `19.2.3` | Server Components, Suspense, Actions. |\n| **Tailwind CSS** | `4.1` | Utility-first styling (Oxide engine). |\n| **Shadcn/ui** | Latest | Radix UI primitives for accessible components. |\n| **Lucide React** | `0.562` | Optimized SVG icons. |\n| **Sonner** | `2.0` | High-performance toast notifications. |\n\n### Backend \u0026 Data\n| Technology | Usage |\n| :--- | :--- |\n| **tRPC** | `v11` | End-to-end typesafe API without schemas. |\n| **Prisma** | `v7.2` | ORM with `adapter-pg` for serverless PostgreSQL. |\n| **Zod** | `v4` | Runtime validation for ENV, API, and Forms. |\n| **Resend** | `v6` | Transactional emails (React Email). |\n| **Upstash QStash** | `v2` | Serverless message queue / cron jobs. |\n| **UploadThing** | `v7` | Direct S3 file uploads (Oregon region). |\n\n### Quality Control \u0026 DX\n| Tool | Purpose |\n| :--- | :--- |\n| **Husky** | Git hooks (pre-commit, pre-push). |\n| **Commitlint** | Enforces Conventional Commits standard. |\n| **Secretlint** | Prevents committing API keys and secrets. |\n| **JSCPD** | Detects copy-pasted code duplicates. |\n| **Bundle Analyzer** | Keeps the build size minimal. |\n\n---\n\n## 🏁 Getting Started\n\n### Prerequisites\n*   Node.js 22+ (Required for Next.js 16)\n*   pnpm 8+ (Recommended)\n\n### Installation\n\n1.  **Clone the repository**\n    ```bash\n    git clone https://github.com/doxynix/doxynix.git\n    cd doxynix\n    ```\n\n2.  **Install dependencies**\n    ```bash\n    pnpm install\n    ```\n\n3.  **Environment Setup**\n    ```bash\n    cp .env.example .env.local\n    ```\n    *Fill in your secrets (Database, Auth, UploadThing).*\n\n4.  **Database Migration**\n    ```bash\n    pnpm prisma generate\n    pnpm prisma db push\n    ```\n\n5.  **Run Development Server**\n    ```bash\n    pnpm dev\n    ```\n\n---\n\n## 🤝 Development Standards\n\nWe strictly follow **Conventional Commits** and ensure code quality via git hooks.\n\n### Commit Message Convention\nYour commit messages must follow the standard: `type(scope): subject`\n\n*   `feat`: A new feature\n*   `fix`: A bug fix\n*   `docs`: Documentation only changes\n*   `style`: Changes that do not affect the meaning of the code\n*   `refactor`: A code change that neither fixes a bug nor adds a feature\n*   `chore`: Changes to the build process or auxiliary tools\n\n**Example:**\n```bash\ngit commit -m \"feat(repo): add copy-paste detection via jscpd\"\n```\n*If you violate this rule, `commitlint` will reject your commit.*\n\n---\n\n## 🛡️ Security\n\nThis project is secured by default.\n*   **Secretlint** scans every commit for leaked keys.\n*   **CodeQL** runs deep semantic code analysis on every push.\n*   **Dependabot** keeps dependencies up to date.\n\nSee [SECURITY.md](SECURITY.md) for our vulnerability reporting policy.\n\n---\n\n## 📄 License\n\nDoxynix is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0-only)**.\n\n### Open Source Use (AGPLv3)\n- **Ideal for:** Individuals, open-source contributors, and self-hosters.\n- **Requirement:** If you modify Doxynix and run it as a service over a network, you **must** make your modified source code available to your users under the same AGPLv3 license. This ensures that all improvements to the \"Engineering Knowledge Base\" engine return to the community.\n\n### Alternative Commercial Licensing\nIf you represent a company or an organization that wants to:\n- Integrate Doxynix into a closed-source commercial product.\n- Use Doxynix in a production environment without the AGPLv3 copyleft restrictions.\n- Receive professional support and enterprise-grade features.\n\nA separate **Commercial License** is available by request. This is not included in the package's SPDX license identifier, but can be negotiated independently for enterprise use cases.\n\n📫 **Contact:** [licensing@doxynix.space](mailto:licensing@doxynix.space)\n\n---\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003eBuilt with ❤️ by \u003ca href=\"https://github.com/doxynix\"\u003eDoxynix Team\u003c/a\u003e\u003c/p\u003e\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoxynix%2Fdoxynix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoxynix%2Fdoxynix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoxynix%2Fdoxynix/lists"}