https://github.com/doxynix/doxynix
Turn your code into insights. Automatic analysis, quality metrics, and documentation generation for GitHub repositories.
https://github.com/doxynix/doxynix
documentation doxynix generator nextjs prisma react tailwindcss trpc typescript zod
Last synced: 25 days ago
JSON representation
Turn your code into insights. Automatic analysis, quality metrics, and documentation generation for GitHub repositories.
- Host: GitHub
- URL: https://github.com/doxynix/doxynix
- Owner: doxynix
- License: agpl-3.0
- Created: 2025-12-20T21:48:02.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-05-02T06:18:48.000Z (about 2 months ago)
- Last Synced: 2026-05-02T08:37:08.903Z (about 2 months ago)
- Topics: documentation, doxynix, generator, nextjs, prisma, react, tailwindcss, trpc, typescript, zod
- Language: TypeScript
- Homepage: https://doxynix.space
- Size: 6.69 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
***
# ⚡ Doxynix
[](https://github.com/doxynix/doxynix/actions)
[](https://github.com/doxynix/doxynix/actions)
[](https://doxynix.space)
[](https://conventionalcommits.org)
[](https://app.relative-ci.com/projects/pSyX3AJ3lNJwWJIvB8qs)
[](https://codecov.io/gh/doxynix/doxynix)
Repository Analysis & Documentation Generator Service
Turn your code into insights. Automatic analysis, quality metrics, and documentation generation for GitHub repositories.
[View Demo](https://doxynix.space) · [Report Bug](https://github.com/doxynix/doxynix/issues) · [Request Feature](https://github.com/doxynix/doxynix/issues)
---
## 🚀 About The Project
**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.
Engineered 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.
### Key Features
* 📊 **Deep Static Analysis:** powered by custom parsers and `jscpd` for copy-paste detection.
* ⚡ **Zero-Latency UI:** Utilizing `TanStack Query` and `PPR` for instant state management.
* 🔒 **Enterprise Security:** `NextAuth.js` with GitHub OAuth, secured by `Secretlint` and `CodeQL`.
* 📄 **Auto-Docs:** `tRPC` to OpenAPI generation via `Scalar`.
* ☁️ **Serverless Infrastructure:** Database on Neon (Pg), queues on Upstash, files on UploadThing.
---
## 🛠️ Tech Stack
### Frontend & UI
| Technology | Version | Usage |
| :--- | :--- | :--- |
| **Next.js** | `16.1.0` | App Router, Server Actions, PPR. |
| **React** | `19.2.3` | Server Components, Suspense, Actions. |
| **Tailwind CSS** | `4.1` | Utility-first styling (Oxide engine). |
| **Shadcn/ui** | Latest | Radix UI primitives for accessible components. |
| **Lucide React** | `0.562` | Optimized SVG icons. |
| **Sonner** | `2.0` | High-performance toast notifications. |
### Backend & Data
| Technology | Usage |
| :--- | :--- |
| **tRPC** | `v11` | End-to-end typesafe API without schemas. |
| **Prisma** | `v7.2` | ORM with `adapter-pg` for serverless PostgreSQL. |
| **Zod** | `v4` | Runtime validation for ENV, API, and Forms. |
| **Resend** | `v6` | Transactional emails (React Email). |
| **Upstash QStash** | `v2` | Serverless message queue / cron jobs. |
| **UploadThing** | `v7` | Direct S3 file uploads (Oregon region). |
### Quality Control & DX
| Tool | Purpose |
| :--- | :--- |
| **Husky** | Git hooks (pre-commit, pre-push). |
| **Commitlint** | Enforces Conventional Commits standard. |
| **Secretlint** | Prevents committing API keys and secrets. |
| **JSCPD** | Detects copy-pasted code duplicates. |
| **Bundle Analyzer** | Keeps the build size minimal. |
---
## 🏁 Getting Started
### Prerequisites
* Node.js 22+ (Required for Next.js 16)
* pnpm 8+ (Recommended)
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/doxynix/doxynix.git
cd doxynix
```
2. **Install dependencies**
```bash
pnpm install
```
3. **Environment Setup**
```bash
cp .env.example .env.local
```
*Fill in your secrets (Database, Auth, UploadThing).*
4. **Database Migration**
```bash
pnpm prisma generate
pnpm prisma db push
```
5. **Run Development Server**
```bash
pnpm dev
```
---
## 🤝 Development Standards
We strictly follow **Conventional Commits** and ensure code quality via git hooks.
### Commit Message Convention
Your commit messages must follow the standard: `type(scope): subject`
* `feat`: A new feature
* `fix`: A bug fix
* `docs`: Documentation only changes
* `style`: Changes that do not affect the meaning of the code
* `refactor`: A code change that neither fixes a bug nor adds a feature
* `chore`: Changes to the build process or auxiliary tools
**Example:**
```bash
git commit -m "feat(repo): add copy-paste detection via jscpd"
```
*If you violate this rule, `commitlint` will reject your commit.*
---
## 🛡️ Security
This project is secured by default.
* **Secretlint** scans every commit for leaked keys.
* **CodeQL** runs deep semantic code analysis on every push.
* **Dependabot** keeps dependencies up to date.
See [SECURITY.md](SECURITY.md) for our vulnerability reporting policy.
---
## 📄 License
Doxynix is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0-only)**.
### Open Source Use (AGPLv3)
- **Ideal for:** Individuals, open-source contributors, and self-hosters.
- **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.
### Alternative Commercial Licensing
If you represent a company or an organization that wants to:
- Integrate Doxynix into a closed-source commercial product.
- Use Doxynix in a production environment without the AGPLv3 copyleft restrictions.
- Receive professional support and enterprise-grade features.
A 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.
📫 **Contact:** [licensing@doxynix.space](mailto:licensing@doxynix.space)
---