@shahadpichen/docpush 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +129 -0
- package/dist/cli/commands/init.d.ts +2 -0
- package/dist/cli/commands/init.d.ts.map +1 -0
- package/dist/cli/commands/init.js +116 -0
- package/dist/cli/commands/init.js.map +1 -0
- package/dist/cli/commands/start.d.ts +4 -0
- package/dist/cli/commands/start.d.ts.map +1 -0
- package/dist/cli/commands/start.js +58 -0
- package/dist/cli/commands/start.js.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +22 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/core/config/index.d.ts +3 -0
- package/dist/core/config/index.d.ts.map +1 -0
- package/dist/core/config/index.js +9 -0
- package/dist/core/config/index.js.map +1 -0
- package/dist/core/config/loader.d.ts +6 -0
- package/dist/core/config/loader.d.ts.map +1 -0
- package/dist/core/config/loader.js +50 -0
- package/dist/core/config/loader.js.map +1 -0
- package/dist/core/config/schema.d.ts +134 -0
- package/dist/core/config/schema.d.ts.map +1 -0
- package/dist/core/config/schema.js +106 -0
- package/dist/core/config/schema.js.map +1 -0
- package/dist/core/errors.d.ts +45 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/errors.js +76 -0
- package/dist/core/errors.js.map +1 -0
- package/dist/core/github/client.d.ts +47 -0
- package/dist/core/github/client.d.ts.map +1 -0
- package/dist/core/github/client.js +159 -0
- package/dist/core/github/client.js.map +1 -0
- package/dist/core/github/index.d.ts +4 -0
- package/dist/core/github/index.d.ts.map +1 -0
- package/dist/core/github/index.js +9 -0
- package/dist/core/github/index.js.map +1 -0
- package/dist/core/github/retry.d.ts +15 -0
- package/dist/core/github/retry.d.ts.map +1 -0
- package/dist/core/github/retry.js +61 -0
- package/dist/core/github/retry.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +40 -0
- package/dist/index.js.map +1 -0
- package/dist/react/components/comments-panel.d.ts +14 -0
- package/dist/react/components/comments-panel.d.ts.map +1 -0
- package/dist/react/components/comments-panel.js +62 -0
- package/dist/react/components/comments-panel.js.map +1 -0
- package/dist/react/components/docs-sidebar.d.ts +13 -0
- package/dist/react/components/docs-sidebar.d.ts.map +1 -0
- package/dist/react/components/docs-sidebar.js +70 -0
- package/dist/react/components/docs-sidebar.js.map +1 -0
- package/dist/react/components/drafts-list.d.ts +18 -0
- package/dist/react/components/drafts-list.d.ts.map +1 -0
- package/dist/react/components/drafts-list.js +38 -0
- package/dist/react/components/drafts-list.js.map +1 -0
- package/dist/react/components/markdown-editor.d.ts +8 -0
- package/dist/react/components/markdown-editor.d.ts.map +1 -0
- package/dist/react/components/markdown-editor.js +59 -0
- package/dist/react/components/markdown-editor.js.map +1 -0
- package/dist/react/components/markdown-viewer.d.ts +7 -0
- package/dist/react/components/markdown-viewer.d.ts.map +1 -0
- package/dist/react/components/markdown-viewer.js +58 -0
- package/dist/react/components/markdown-viewer.js.map +1 -0
- package/dist/react/components/search-bar.d.ts +14 -0
- package/dist/react/components/search-bar.d.ts.map +1 -0
- package/dist/react/components/search-bar.js +80 -0
- package/dist/react/components/search-bar.js.map +1 -0
- package/dist/react/components/ui/badge.d.ts +10 -0
- package/dist/react/components/ui/badge.d.ts.map +1 -0
- package/dist/react/components/ui/badge.js +27 -0
- package/dist/react/components/ui/badge.js.map +1 -0
- package/dist/react/components/ui/button.d.ts +12 -0
- package/dist/react/components/ui/button.d.ts.map +1 -0
- package/dist/react/components/ui/button.js +71 -0
- package/dist/react/components/ui/button.js.map +1 -0
- package/dist/react/components/ui/card.d.ts +7 -0
- package/dist/react/components/ui/card.d.ts.map +1 -0
- package/dist/react/components/ui/card.js +52 -0
- package/dist/react/components/ui/card.js.map +1 -0
- package/dist/react/components/ui/input.d.ts +6 -0
- package/dist/react/components/ui/input.d.ts.map +1 -0
- package/dist/react/components/ui/input.js +45 -0
- package/dist/react/components/ui/input.js.map +1 -0
- package/dist/react/components/ui/scroll-area.d.ts +6 -0
- package/dist/react/components/ui/scroll-area.d.ts.map +1 -0
- package/dist/react/components/ui/scroll-area.js +48 -0
- package/dist/react/components/ui/scroll-area.js.map +1 -0
- package/dist/react/components/ui/textarea.d.ts +6 -0
- package/dist/react/components/ui/textarea.d.ts.map +1 -0
- package/dist/react/components/ui/textarea.js +45 -0
- package/dist/react/components/ui/textarea.js.map +1 -0
- package/dist/react/context/docpush-provider.d.ts +17 -0
- package/dist/react/context/docpush-provider.d.ts.map +1 -0
- package/dist/react/context/docpush-provider.js +72 -0
- package/dist/react/context/docpush-provider.js.map +1 -0
- package/dist/react/hooks/use-auth.d.ts +16 -0
- package/dist/react/hooks/use-auth.d.ts.map +1 -0
- package/dist/react/hooks/use-auth.js +72 -0
- package/dist/react/hooks/use-auth.js.map +1 -0
- package/dist/react/hooks/use-comments.d.ts +15 -0
- package/dist/react/hooks/use-comments.d.ts.map +1 -0
- package/dist/react/hooks/use-comments.js +67 -0
- package/dist/react/hooks/use-comments.js.map +1 -0
- package/dist/react/hooks/use-docs.d.ts +13 -0
- package/dist/react/hooks/use-docs.d.ts.map +1 -0
- package/dist/react/hooks/use-docs.js +69 -0
- package/dist/react/hooks/use-docs.js.map +1 -0
- package/dist/react/hooks/use-drafts.d.ts +25 -0
- package/dist/react/hooks/use-drafts.d.ts.map +1 -0
- package/dist/react/hooks/use-drafts.js +99 -0
- package/dist/react/hooks/use-drafts.js.map +1 -0
- package/dist/react/index.d.ts +19 -0
- package/dist/react/index.d.ts.map +1 -0
- package/dist/react/index.js +52 -0
- package/dist/react/index.js.map +1 -0
- package/dist/react/lib/utils.d.ts +3 -0
- package/dist/react/lib/utils.d.ts.map +1 -0
- package/dist/react/lib/utils.js +9 -0
- package/dist/react/lib/utils.js.map +1 -0
- package/dist/server/auth/index.d.ts +18 -0
- package/dist/server/auth/index.d.ts.map +1 -0
- package/dist/server/auth/index.js +50 -0
- package/dist/server/auth/index.js.map +1 -0
- package/dist/server/auth/magic-link.d.ts +10 -0
- package/dist/server/auth/magic-link.d.ts.map +1 -0
- package/dist/server/auth/magic-link.js +94 -0
- package/dist/server/auth/magic-link.js.map +1 -0
- package/dist/server/auth/oauth.d.ts +6 -0
- package/dist/server/auth/oauth.d.ts.map +1 -0
- package/dist/server/auth/oauth.js +90 -0
- package/dist/server/auth/oauth.js.map +1 -0
- package/dist/server/auth/public.d.ts +7 -0
- package/dist/server/auth/public.d.ts.map +1 -0
- package/dist/server/auth/public.js +43 -0
- package/dist/server/auth/public.js.map +1 -0
- package/dist/server/index.d.ts +12 -0
- package/dist/server/index.d.ts.map +1 -0
- package/dist/server/index.js +107 -0
- package/dist/server/index.js.map +1 -0
- package/dist/server/middleware/auth.d.ts +20 -0
- package/dist/server/middleware/auth.d.ts.map +1 -0
- package/dist/server/middleware/auth.js +49 -0
- package/dist/server/middleware/auth.js.map +1 -0
- package/dist/server/routes/auth.d.ts +3 -0
- package/dist/server/routes/auth.d.ts.map +1 -0
- package/dist/server/routes/auth.js +105 -0
- package/dist/server/routes/auth.js.map +1 -0
- package/dist/server/routes/docs.d.ts +3 -0
- package/dist/server/routes/docs.d.ts.map +1 -0
- package/dist/server/routes/docs.js +58 -0
- package/dist/server/routes/docs.js.map +1 -0
- package/dist/server/routes/drafts.d.ts +3 -0
- package/dist/server/routes/drafts.d.ts.map +1 -0
- package/dist/server/routes/drafts.js +264 -0
- package/dist/server/routes/drafts.js.map +1 -0
- package/dist/server/routes/index.d.ts +4 -0
- package/dist/server/routes/index.d.ts.map +1 -0
- package/dist/server/routes/index.js +13 -0
- package/dist/server/routes/index.js.map +1 -0
- package/dist/server/storage/index.d.ts +40 -0
- package/dist/server/storage/index.d.ts.map +1 -0
- package/dist/server/storage/index.js +199 -0
- package/dist/server/storage/index.js.map +1 -0
- package/package.json +109 -0
- package/templates/.env.example +20 -0
- package/templates/docs.config.js +21 -0
package/package.json
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@shahadpichen/docpush",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"access": "public"
|
|
6
|
+
},
|
|
7
|
+
"description": "Self-hosted, Git-backed collaborative documentation platform",
|
|
8
|
+
"keywords": [
|
|
9
|
+
"documentation",
|
|
10
|
+
"markdown",
|
|
11
|
+
"git",
|
|
12
|
+
"collaborative",
|
|
13
|
+
"cms",
|
|
14
|
+
"self-hosted"
|
|
15
|
+
],
|
|
16
|
+
"homepage": "https://github.com/shahadpichen/docpush",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "https://github.com/shahadpichen/docpush.git"
|
|
20
|
+
},
|
|
21
|
+
"license": "MIT",
|
|
22
|
+
"author": "DocPush Team",
|
|
23
|
+
"main": "./dist/index.js",
|
|
24
|
+
"types": "./dist/index.d.ts",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"types": "./dist/index.d.ts",
|
|
28
|
+
"default": "./dist/index.js"
|
|
29
|
+
},
|
|
30
|
+
"./react": {
|
|
31
|
+
"types": "./dist/react/index.d.ts",
|
|
32
|
+
"default": "./dist/react/index.js"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"bin": {
|
|
36
|
+
"docpush": "./dist/cli/index.js"
|
|
37
|
+
},
|
|
38
|
+
"files": [
|
|
39
|
+
"dist",
|
|
40
|
+
"templates",
|
|
41
|
+
"README.md",
|
|
42
|
+
"LICENSE"
|
|
43
|
+
],
|
|
44
|
+
"scripts": {
|
|
45
|
+
"dev:server": "tsx watch src/server/index.ts",
|
|
46
|
+
"build": "tsc",
|
|
47
|
+
"build:server": "tsc",
|
|
48
|
+
"clean": "rm -rf dist",
|
|
49
|
+
"prepublishOnly": "npm run clean && npm run build",
|
|
50
|
+
"test": "jest",
|
|
51
|
+
"lint": "biome check src",
|
|
52
|
+
"lint:fix": "biome check src --write",
|
|
53
|
+
"format": "biome format src --write"
|
|
54
|
+
},
|
|
55
|
+
"dependencies": {
|
|
56
|
+
"@octokit/rest": "^20.0.2",
|
|
57
|
+
"axios": "^1.6.2",
|
|
58
|
+
"chalk": "^4.1.2",
|
|
59
|
+
"commander": "^11.1.0",
|
|
60
|
+
"cors": "^2.8.5",
|
|
61
|
+
"dotenv": "^17.2.3",
|
|
62
|
+
"express": "^4.18.2",
|
|
63
|
+
"express-session": "^1.17.3",
|
|
64
|
+
"fs-extra": "^11.2.0",
|
|
65
|
+
"gray-matter": "^4.0.3",
|
|
66
|
+
"passport": "^0.7.0",
|
|
67
|
+
"passport-custom": "^1.1.1",
|
|
68
|
+
"passport-github2": "^0.1.12",
|
|
69
|
+
"passport-google-oauth20": "^2.0.0",
|
|
70
|
+
"resend": "^3.0.0",
|
|
71
|
+
"zod": "^3.22.4"
|
|
72
|
+
},
|
|
73
|
+
"devDependencies": {
|
|
74
|
+
"@biomejs/biome": "^1.5.0",
|
|
75
|
+
"@radix-ui/react-scroll-area": "^1.0.5",
|
|
76
|
+
"@radix-ui/react-slot": "^1.0.2",
|
|
77
|
+
"@types/cors": "^2.8.17",
|
|
78
|
+
"@types/express": "^4.17.21",
|
|
79
|
+
"@types/express-session": "^1.17.10",
|
|
80
|
+
"@types/fs-extra": "^11.0.4",
|
|
81
|
+
"@types/node": "^20.10.6",
|
|
82
|
+
"@types/passport": "^1.0.16",
|
|
83
|
+
"@types/passport-github2": "^1.2.9",
|
|
84
|
+
"@types/passport-google-oauth20": "^2.0.14",
|
|
85
|
+
"@types/react": "^18.2.47",
|
|
86
|
+
"@types/react-dom": "^18.2.18",
|
|
87
|
+
"class-variance-authority": "^0.7.0",
|
|
88
|
+
"clsx": "^2.1.0",
|
|
89
|
+
"tailwind-merge": "^2.2.0",
|
|
90
|
+
"tsx": "^4.7.0",
|
|
91
|
+
"typescript": "^5.3.3"
|
|
92
|
+
},
|
|
93
|
+
"peerDependencies": {
|
|
94
|
+
"react": "^18.0.0",
|
|
95
|
+
"react-dom": "^18.0.0"
|
|
96
|
+
},
|
|
97
|
+
"peerDependenciesMeta": {
|
|
98
|
+
"react": {
|
|
99
|
+
"optional": true
|
|
100
|
+
},
|
|
101
|
+
"react-dom": {
|
|
102
|
+
"optional": true
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"engines": {
|
|
106
|
+
"node": ">=18.0.0",
|
|
107
|
+
"npm": ">=9.0.0"
|
|
108
|
+
}
|
|
109
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DocPush Environment Variables
|
|
2
|
+
# Copy this to .env in your project root
|
|
3
|
+
|
|
4
|
+
# Required: GitHub Personal Access Token with repo scope
|
|
5
|
+
GITHUB_TOKEN=ghp_your_token_here
|
|
6
|
+
|
|
7
|
+
# Required: Your app's public URL
|
|
8
|
+
APP_URL=http://localhost:3000
|
|
9
|
+
|
|
10
|
+
# Required: Session secret (generate a random string for production)
|
|
11
|
+
SESSION_SECRET=your-secret-key-here
|
|
12
|
+
|
|
13
|
+
# Optional: For domain-restricted auth mode
|
|
14
|
+
# RESEND_API_KEY=re_your_resend_key
|
|
15
|
+
|
|
16
|
+
# Optional: For OAuth auth mode
|
|
17
|
+
# GITHUB_CLIENT_ID=your_github_oauth_client_id
|
|
18
|
+
# GITHUB_CLIENT_SECRET=your_github_oauth_client_secret
|
|
19
|
+
# GOOGLE_CLIENT_ID=your_google_oauth_client_id
|
|
20
|
+
# GOOGLE_CLIENT_SECRET=your_google_oauth_client_secret
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// DocPush Configuration
|
|
2
|
+
// Copy this to docs.config.js in your project root
|
|
3
|
+
|
|
4
|
+
module.exports = {
|
|
5
|
+
github: {
|
|
6
|
+
owner: "your-github-username",
|
|
7
|
+
repo: "your-repo-name",
|
|
8
|
+
branch: "main",
|
|
9
|
+
docsPath: "docs",
|
|
10
|
+
},
|
|
11
|
+
auth: {
|
|
12
|
+
mode: "public",
|
|
13
|
+
adminPassword: "change-me-in-production",
|
|
14
|
+
},
|
|
15
|
+
admins: {
|
|
16
|
+
emails: ["admin@example.com"],
|
|
17
|
+
},
|
|
18
|
+
branding: {
|
|
19
|
+
name: "My Documentation",
|
|
20
|
+
},
|
|
21
|
+
};
|