create-kitcms 0.0.0-stage → 0.1.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/LICENSE +21 -0
- package/README.md +36 -2
- package/bin/create.js +5 -0
- package/dist/args.d.ts +15 -0
- package/dist/args.js +72 -0
- package/dist/index.d.ts +30 -0
- package/dist/index.js +150 -0
- package/dist/scaffold.d.ts +25 -0
- package/dist/scaffold.js +98 -0
- package/dist/wrangler.d.ts +2 -0
- package/dist/wrangler.js +7 -0
- package/package.json +34 -3
- package/templates/blank/.dev.vars.example +1 -0
- package/templates/blank/README.md +39 -0
- package/templates/blank/_gitignore +7 -0
- package/templates/blank/package.json +37 -0
- package/templates/blank/pnpm-workspace.yaml +3 -0
- package/templates/blank/src/app.d.ts +22 -0
- package/templates/blank/src/app.html +11 -0
- package/templates/blank/src/hooks.server.ts +4 -0
- package/templates/blank/src/kitcms.admin.ts +14 -0
- package/templates/blank/src/kitcms.config.ts +32 -0
- package/templates/blank/src/kitcms.rpc.ts +6 -0
- package/templates/blank/src/lib/index.ts +1 -0
- package/templates/blank/src/routes/(kitcms)/admin/[...path]/+page.server.ts +2 -0
- package/templates/blank/src/routes/(kitcms)/admin/[...path]/+page.svelte +9 -0
- package/templates/blank/src/routes/(kitcms)/api/[...path]/+server.ts +2 -0
- package/templates/blank/src/routes/+page.server.ts +7 -0
- package/templates/blank/src/routes/+page.svelte +19 -0
- package/templates/blank/tsconfig.json +11 -0
- package/templates/blank/vite.config.ts +8 -0
- package/templates/blank/wrangler.jsonc +28 -0
- package/templates/website/.dev.vars.example +1 -0
- package/templates/website/README.md +105 -0
- package/templates/website/_gitignore +7 -0
- package/templates/website/package.json +42 -0
- package/templates/website/pnpm-workspace.yaml +3 -0
- package/templates/website/src/app.css +23 -0
- package/templates/website/src/app.d.ts +22 -0
- package/templates/website/src/app.html +11 -0
- package/templates/website/src/hooks.server.ts +4 -0
- package/templates/website/src/kitcms.admin.ts +19 -0
- package/templates/website/src/kitcms.config.ts +269 -0
- package/templates/website/src/kitcms.rpc.ts +6 -0
- package/templates/website/src/kitcms.seed.ts +232 -0
- package/templates/website/src/lib/Img.svelte +62 -0
- package/templates/website/src/lib/Link.svelte +10 -0
- package/templates/website/src/lib/PageView.svelte +30 -0
- package/templates/website/src/lib/PostList.svelte +169 -0
- package/templates/website/src/lib/RichText.svelte +13 -0
- package/templates/website/src/lib/Seo.svelte +31 -0
- package/templates/website/src/lib/blocks/AdminPreview.svelte +59 -0
- package/templates/website/src/lib/blocks/Cta.svelte +86 -0
- package/templates/website/src/lib/blocks/Features.svelte +147 -0
- package/templates/website/src/lib/blocks/Gallery.svelte +122 -0
- package/templates/website/src/lib/blocks/Hero.svelte +151 -0
- package/templates/website/src/lib/blocks/LatestPosts.svelte +36 -0
- package/templates/website/src/lib/blocks/RenderBlocks.svelte +38 -0
- package/templates/website/src/lib/blocks/ResolveMedia.svelte +27 -0
- package/templates/website/src/lib/blocks/RichTextBlock.svelte +47 -0
- package/templates/website/src/lib/blocks/TeamGrid.svelte +159 -0
- package/templates/website/src/lib/blocks/types.ts +47 -0
- package/templates/website/src/lib/content.ts +31 -0
- package/templates/website/src/lib/designs.ts +79 -0
- package/templates/website/src/lib/format.ts +3 -0
- package/templates/website/src/lib/icons.ts +13 -0
- package/templates/website/src/lib/image.ts +29 -0
- package/templates/website/src/lib/index.ts +1 -0
- package/templates/website/src/lib/media.ts +32 -0
- package/templates/website/src/lib/shell/Footer.svelte +146 -0
- package/templates/website/src/lib/shell/Header.svelte +121 -0
- package/templates/website/src/lib/shell/MobileMenu.svelte +142 -0
- package/templates/website/src/lib/shell/shell.ts +52 -0
- package/templates/website/src/lib/site.css +329 -0
- package/templates/website/src/routes/(kitcms)/admin/[...path]/+page.server.ts +2 -0
- package/templates/website/src/routes/(kitcms)/admin/[...path]/+page.svelte +9 -0
- package/templates/website/src/routes/(kitcms)/api/[...path]/+server.ts +2 -0
- package/templates/website/src/routes/(site)/+error.svelte +23 -0
- package/templates/website/src/routes/(site)/+layout.server.ts +12 -0
- package/templates/website/src/routes/(site)/+layout.svelte +63 -0
- package/templates/website/src/routes/(site)/+page.server.ts +7 -0
- package/templates/website/src/routes/(site)/+page.svelte +33 -0
- package/templates/website/src/routes/(site)/[slug]/+page.server.ts +11 -0
- package/templates/website/src/routes/(site)/[slug]/+page.svelte +9 -0
- package/templates/website/src/routes/(site)/blog/+page.server.ts +20 -0
- package/templates/website/src/routes/(site)/blog/+page.svelte +66 -0
- package/templates/website/src/routes/(site)/blog/[slug]/+page.server.ts +11 -0
- package/templates/website/src/routes/(site)/blog/[slug]/+page.svelte +231 -0
- package/templates/website/src/routes/(site)/legal/[slug]/+page.server.ts +8 -0
- package/templates/website/src/routes/(site)/legal/[slug]/+page.svelte +23 -0
- package/templates/website/tsconfig.json +11 -0
- package/templates/website/vite.config.ts +8 -0
- package/templates/website/wrangler.jsonc +28 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 kitcms contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,37 @@
|
|
|
1
|
-
#
|
|
1
|
+
# create-kitcms
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Scaffolds a kitcms app: a SvelteKit project wired to `@kitcms/core` and `@kitcms/ui`, with a config, the admin route and a Cloudflare Worker setup (D1 and R2 bindings).
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
pnpm create kitcms@latest my-site
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Then:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
cd my-site
|
|
13
|
+
pnpm dev
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
create-kitcms: scaffold a kitcms app
|
|
20
|
+
|
|
21
|
+
Usage: pnpm create kitcms@latest [dir] [options]
|
|
22
|
+
|
|
23
|
+
Options:
|
|
24
|
+
--template <name> Template to use: blank | website (default: blank)
|
|
25
|
+
--create-resources Create the D1 database and R2 bucket with wrangler (needs "wrangler login")
|
|
26
|
+
--yes, -y Accept defaults, never prompt
|
|
27
|
+
--no-install Skip "pnpm install" and the local migration
|
|
28
|
+
--link <repo> Use link: dependencies on a local kitcms checkout (for testing)
|
|
29
|
+
--help, -h Show this help
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Templates:
|
|
33
|
+
|
|
34
|
+
- `blank`: the admin plus one minimal `pages` collection.
|
|
35
|
+
- `website`: a small business/studio site: pages built from blocks (with live preview), blog with tags, team, locked legal pages, site settings, seed content and Cloudflare image transformations. Run `pnpm kitcms seed` after scaffolding to fill it with example content.
|
|
36
|
+
|
|
37
|
+
Status: pre-release (0.x), Cloudflare Workers + D1 + R2 only.
|
package/bin/create.js
ADDED
package/dist/args.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export interface Args {
|
|
2
|
+
dir?: string;
|
|
3
|
+
template: string;
|
|
4
|
+
createResources: boolean;
|
|
5
|
+
yes: boolean;
|
|
6
|
+
install: boolean;
|
|
7
|
+
link?: string;
|
|
8
|
+
help: boolean;
|
|
9
|
+
/** Set when `--template` was passed explicitly. */
|
|
10
|
+
templateGiven: boolean;
|
|
11
|
+
unknown: string[];
|
|
12
|
+
}
|
|
13
|
+
export declare const TEMPLATES: readonly ["blank", "website"];
|
|
14
|
+
export declare const USAGE = "create-kitcms: scaffold a kitcms app\n\nUsage: pnpm create kitcms@latest [dir] [options]\n\nOptions:\n --template <name> Template to use: blank | website (default: blank)\n --create-resources Create the D1 database and R2 bucket with wrangler (needs \"wrangler login\")\n --yes, -y Accept defaults, never prompt\n --no-install Skip \"pnpm install\" and the local migration\n --link <repo> Use link: dependencies on a local kitcms checkout (for testing)\n --help, -h Show this help\n";
|
|
15
|
+
export declare function parseArgs(argv: string[]): Args;
|
package/dist/args.js
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
export const TEMPLATES = ['blank', 'website'];
|
|
2
|
+
export const USAGE = `create-kitcms: scaffold a kitcms app
|
|
3
|
+
|
|
4
|
+
Usage: pnpm create kitcms@latest [dir] [options]
|
|
5
|
+
|
|
6
|
+
Options:
|
|
7
|
+
--template <name> Template to use: blank | website (default: blank)
|
|
8
|
+
--create-resources Create the D1 database and R2 bucket with wrangler (needs "wrangler login")
|
|
9
|
+
--yes, -y Accept defaults, never prompt
|
|
10
|
+
--no-install Skip "pnpm install" and the local migration
|
|
11
|
+
--link <repo> Use link: dependencies on a local kitcms checkout (for testing)
|
|
12
|
+
--help, -h Show this help
|
|
13
|
+
`;
|
|
14
|
+
export function parseArgs(argv) {
|
|
15
|
+
const args = {
|
|
16
|
+
template: 'blank',
|
|
17
|
+
templateGiven: false,
|
|
18
|
+
createResources: false,
|
|
19
|
+
yes: false,
|
|
20
|
+
install: true,
|
|
21
|
+
help: false,
|
|
22
|
+
unknown: [],
|
|
23
|
+
};
|
|
24
|
+
for (let i = 0; i < argv.length; i++) {
|
|
25
|
+
const a = argv[i];
|
|
26
|
+
const eq = a.indexOf('=');
|
|
27
|
+
const [flag, inline] = a.startsWith('--') && eq > 0 ? [a.slice(0, eq), a.slice(eq + 1)] : [a, undefined];
|
|
28
|
+
const value = () => inline ?? argv[++i];
|
|
29
|
+
switch (flag) {
|
|
30
|
+
case '--template': {
|
|
31
|
+
const v = value();
|
|
32
|
+
if (v === undefined)
|
|
33
|
+
args.unknown.push('--template (missing value)');
|
|
34
|
+
else {
|
|
35
|
+
args.template = v;
|
|
36
|
+
args.templateGiven = true;
|
|
37
|
+
}
|
|
38
|
+
break;
|
|
39
|
+
}
|
|
40
|
+
case '--link': {
|
|
41
|
+
const v = value();
|
|
42
|
+
if (v === undefined)
|
|
43
|
+
args.unknown.push('--link (missing value)');
|
|
44
|
+
else
|
|
45
|
+
args.link = v;
|
|
46
|
+
break;
|
|
47
|
+
}
|
|
48
|
+
case '--create-resources':
|
|
49
|
+
args.createResources = true;
|
|
50
|
+
break;
|
|
51
|
+
case '--yes':
|
|
52
|
+
case '-y':
|
|
53
|
+
args.yes = true;
|
|
54
|
+
break;
|
|
55
|
+
case '--no-install':
|
|
56
|
+
args.install = false;
|
|
57
|
+
break;
|
|
58
|
+
case '--help':
|
|
59
|
+
case '-h':
|
|
60
|
+
args.help = true;
|
|
61
|
+
break;
|
|
62
|
+
default:
|
|
63
|
+
if (a.startsWith('-'))
|
|
64
|
+
args.unknown.push(a);
|
|
65
|
+
else if (args.dir === undefined)
|
|
66
|
+
args.dir = a;
|
|
67
|
+
else
|
|
68
|
+
args.unknown.push(a);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
return args;
|
|
72
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export declare const VERSION: string;
|
|
2
|
+
export { parseArgs, USAGE, type Args } from './args.js';
|
|
3
|
+
export * from './scaffold.js';
|
|
4
|
+
export { parseDatabaseId } from './wrangler.js';
|
|
5
|
+
export interface ExecResult {
|
|
6
|
+
code: number;
|
|
7
|
+
stdout: string;
|
|
8
|
+
stderr: string;
|
|
9
|
+
}
|
|
10
|
+
export interface Deps {
|
|
11
|
+
cwd: string;
|
|
12
|
+
log: (message: string) => void;
|
|
13
|
+
/** Runs a command; `inherit` streams its output to the terminal. */
|
|
14
|
+
exec: (cmd: string, args: string[], opts: {
|
|
15
|
+
cwd: string;
|
|
16
|
+
inherit?: boolean;
|
|
17
|
+
}) => Promise<ExecResult>;
|
|
18
|
+
/** Asks a question; resolves with the answer or the default. */
|
|
19
|
+
ask: (question: string, fallback: string) => Promise<string>;
|
|
20
|
+
interactive: boolean;
|
|
21
|
+
/** Overrides the templates directory (tests). */
|
|
22
|
+
templatesDir?: string;
|
|
23
|
+
}
|
|
24
|
+
export declare function nodeExec(cmd: string, args: string[], opts: {
|
|
25
|
+
cwd: string;
|
|
26
|
+
inherit?: boolean;
|
|
27
|
+
}): Promise<ExecResult>;
|
|
28
|
+
export declare function main(argv: string[]): Promise<number>;
|
|
29
|
+
/** Runs the scaffolder and returns the process exit code. */
|
|
30
|
+
export declare function run(argv: string[], deps: Deps): Promise<number>;
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { spawn } from 'node:child_process';
|
|
2
|
+
import { createRequire } from 'node:module';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import readline from 'node:readline/promises';
|
|
5
|
+
import { TEMPLATES, USAGE, parseArgs } from './args.js';
|
|
6
|
+
import { copyTemplate, isNonEmptyDir, linkDependencies, setDatabaseId, templatesDir, toAppName, writeDevVars, } from './scaffold.js';
|
|
7
|
+
import { parseDatabaseId } from './wrangler.js';
|
|
8
|
+
// `src/` and `dist/` both sit one level below package.json.
|
|
9
|
+
export const VERSION = createRequire(import.meta.url)('../package.json').version;
|
|
10
|
+
export { parseArgs, USAGE } from './args.js';
|
|
11
|
+
export * from './scaffold.js';
|
|
12
|
+
export { parseDatabaseId } from './wrangler.js';
|
|
13
|
+
export function nodeExec(cmd, args, opts) {
|
|
14
|
+
return new Promise((resolve) => {
|
|
15
|
+
const child = spawn(cmd, args, { cwd: opts.cwd, stdio: opts.inherit ? 'inherit' : ['ignore', 'pipe', 'pipe'] });
|
|
16
|
+
let stdout = '';
|
|
17
|
+
let stderr = '';
|
|
18
|
+
child.stdout?.on('data', (d) => (stdout += d));
|
|
19
|
+
child.stderr?.on('data', (d) => (stderr += d));
|
|
20
|
+
child.on('error', (e) => resolve({ code: 127, stdout, stderr: stderr + String(e) }));
|
|
21
|
+
child.on('close', (code) => resolve({ code: code ?? 1, stdout, stderr }));
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
function nodeDeps() {
|
|
25
|
+
const interactive = Boolean(process.stdin.isTTY && process.stdout.isTTY);
|
|
26
|
+
return {
|
|
27
|
+
cwd: process.cwd(),
|
|
28
|
+
log: (m) => console.log(m),
|
|
29
|
+
exec: nodeExec,
|
|
30
|
+
interactive,
|
|
31
|
+
ask: async (question, fallback) => {
|
|
32
|
+
const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
|
|
33
|
+
try {
|
|
34
|
+
const answer = (await rl.question(`${question} (${fallback}) `)).trim();
|
|
35
|
+
return answer || fallback;
|
|
36
|
+
}
|
|
37
|
+
finally {
|
|
38
|
+
rl.close();
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
export async function main(argv) {
|
|
44
|
+
try {
|
|
45
|
+
return await run(argv, nodeDeps());
|
|
46
|
+
}
|
|
47
|
+
catch (e) {
|
|
48
|
+
console.error(`create-kitcms: ${e instanceof Error ? e.message : String(e)}`);
|
|
49
|
+
return 1;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
/** Runs the scaffolder and returns the process exit code. */
|
|
53
|
+
export async function run(argv, deps) {
|
|
54
|
+
const { log } = deps;
|
|
55
|
+
const args = parseArgs(argv);
|
|
56
|
+
if (args.help)
|
|
57
|
+
return log(USAGE), 0;
|
|
58
|
+
if (args.unknown.length) {
|
|
59
|
+
log(`create-kitcms: unknown option "${args.unknown[0]}"\n\n${USAGE}`);
|
|
60
|
+
return 1;
|
|
61
|
+
}
|
|
62
|
+
const ask = async (q, d) => (args.yes || !deps.interactive ? d : deps.ask(q, d));
|
|
63
|
+
// Offer the templates when none was given (interactive runs only).
|
|
64
|
+
if (!args.templateGiven)
|
|
65
|
+
args.template = (await ask(`Template? (${TEMPLATES.join(' | ')})`, args.template)).toLowerCase();
|
|
66
|
+
if (!TEMPLATES.includes(args.template)) {
|
|
67
|
+
log(`create-kitcms: unknown template "${args.template}" (available: ${TEMPLATES.join(', ')})`);
|
|
68
|
+
return 1;
|
|
69
|
+
}
|
|
70
|
+
const dirInput = args.dir ?? (await ask('Project name / directory?', 'kitcms-app'));
|
|
71
|
+
const target = path.resolve(deps.cwd, dirInput);
|
|
72
|
+
if (isNonEmptyDir(target)) {
|
|
73
|
+
log(`create-kitcms: target directory "${target}" is not empty. Pick another name or empty it first.`);
|
|
74
|
+
return 1;
|
|
75
|
+
}
|
|
76
|
+
const appName = toAppName(path.basename(target));
|
|
77
|
+
const names = { db: appName, bucket: appName };
|
|
78
|
+
const root = deps.templatesDir ?? templatesDir();
|
|
79
|
+
copyTemplate(path.join(root, args.template), target, {
|
|
80
|
+
__APP_NAME__: appName,
|
|
81
|
+
__DB_NAME__: names.db,
|
|
82
|
+
__DB_ID__: `<run: wrangler d1 create ${names.db}>`,
|
|
83
|
+
__BUCKET_NAME__: names.bucket,
|
|
84
|
+
});
|
|
85
|
+
writeDevVars(target);
|
|
86
|
+
if (args.link)
|
|
87
|
+
linkDependencies(target, args.link);
|
|
88
|
+
log(`Created ${appName} in ${target}`);
|
|
89
|
+
let installed = false;
|
|
90
|
+
if (args.install) {
|
|
91
|
+
log('\nInstalling dependencies with pnpm...');
|
|
92
|
+
const r = await deps.exec('pnpm', ['install'], { cwd: target, inherit: true });
|
|
93
|
+
installed = r.code === 0;
|
|
94
|
+
if (!installed)
|
|
95
|
+
log('pnpm install failed. Fix the error above, then run it yourself.');
|
|
96
|
+
}
|
|
97
|
+
// D1 + R2 on the user's Cloudflare account (only when logged in to wrangler).
|
|
98
|
+
let resourcesCreated = false;
|
|
99
|
+
if (installed) {
|
|
100
|
+
const wrangler = (a) => deps.exec('pnpm', ['exec', 'wrangler', ...a], { cwd: target });
|
|
101
|
+
let want = args.createResources;
|
|
102
|
+
let loggedIn;
|
|
103
|
+
if (!want && !args.yes && deps.interactive) {
|
|
104
|
+
loggedIn = (await wrangler(['whoami'])).code === 0;
|
|
105
|
+
if (loggedIn)
|
|
106
|
+
want = /^y/i.test(await ask('Create the D1 database and R2 bucket now?', 'y'));
|
|
107
|
+
}
|
|
108
|
+
if (want) {
|
|
109
|
+
loggedIn ??= (await wrangler(['whoami'])).code === 0;
|
|
110
|
+
if (!loggedIn)
|
|
111
|
+
log('wrangler is not logged in (run "pnpm exec wrangler login"); skipping resource creation.');
|
|
112
|
+
else {
|
|
113
|
+
const d1 = await wrangler(['d1', 'create', names.db]);
|
|
114
|
+
const id = parseDatabaseId(d1.stdout + d1.stderr);
|
|
115
|
+
const r2 = await wrangler(['r2', 'bucket', 'create', names.bucket]);
|
|
116
|
+
if (d1.code === 0 && id)
|
|
117
|
+
setDatabaseId(target, id);
|
|
118
|
+
else
|
|
119
|
+
log(`Could not create the D1 database:\n${d1.stdout}${d1.stderr}`);
|
|
120
|
+
if (r2.code !== 0)
|
|
121
|
+
log(`Could not create the R2 bucket:\n${r2.stdout}${r2.stderr}`);
|
|
122
|
+
resourcesCreated = d1.code === 0 && Boolean(id) && r2.code === 0;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
let migrated = false;
|
|
127
|
+
if (installed) {
|
|
128
|
+
log('\nGenerating and applying the initial migration (local D1)...');
|
|
129
|
+
const gen = await deps.exec('pnpm', ['exec', 'kitcms', 'migrate:create', 'init'], { cwd: target, inherit: true });
|
|
130
|
+
const mig = gen.code === 0 ? await deps.exec('pnpm', ['exec', 'kitcms', 'migrate'], { cwd: target, inherit: true }) : gen;
|
|
131
|
+
migrated = mig.code === 0;
|
|
132
|
+
if (!migrated)
|
|
133
|
+
log('The local migration failed. Fix the error above, then run "pnpm db:generate init && pnpm db:migrate".');
|
|
134
|
+
}
|
|
135
|
+
const rel = path.relative(deps.cwd, target) || '.';
|
|
136
|
+
const steps = [`cd ${rel}`];
|
|
137
|
+
if (!installed)
|
|
138
|
+
steps.push('pnpm install');
|
|
139
|
+
if (!migrated)
|
|
140
|
+
steps.push('pnpm db:generate init', 'pnpm db:migrate');
|
|
141
|
+
if (args.template === 'website')
|
|
142
|
+
steps.push('pnpm kitcms seed # example pages, posts, team, legal pages and site settings');
|
|
143
|
+
steps.push('pnpm dev', '(open http://localhost:5173/admin to create the first admin user)');
|
|
144
|
+
log(`\nNext steps:\n ${steps.join('\n ')}`);
|
|
145
|
+
if (!resourcesCreated) {
|
|
146
|
+
log(`\nBefore deploying, create the Cloudflare resources and put the D1 database_id into wrangler.jsonc:\n pnpm exec wrangler d1 create ${names.db}\n pnpm exec wrangler r2 bucket create ${names.bucket}`);
|
|
147
|
+
}
|
|
148
|
+
log(`\nDeploy (requires Workers Paid: password hashing exceeds the Free plan CPU limit):\n pnpm db:migrate --remote\n pnpm exec wrangler secret put BETTER_AUTH_SECRET\n pnpm run deploy`);
|
|
149
|
+
return 0;
|
|
150
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
export interface Placeholders {
|
|
2
|
+
__APP_NAME__: string;
|
|
3
|
+
__DB_NAME__: string;
|
|
4
|
+
__DB_ID__: string;
|
|
5
|
+
__BUCKET_NAME__: string;
|
|
6
|
+
}
|
|
7
|
+
/** Placeholders that may legitimately remain after scaffolding (none: the D1 id gets an explicit hint). */
|
|
8
|
+
export declare const DOCUMENTED_PLACEHOLDERS: readonly string[];
|
|
9
|
+
/** Package root: dist/ (or src/) sits one level below it. */
|
|
10
|
+
export declare function packageRoot(): string;
|
|
11
|
+
/** Published: `<pkg>/templates` (copied by `prepack`). Monorepo checkout: `<repo>/templates`. */
|
|
12
|
+
export declare function templatesDir(root?: string): string;
|
|
13
|
+
export declare function toAppName(input: string): string;
|
|
14
|
+
export declare function replacePlaceholders(text: string, values: Placeholders): string;
|
|
15
|
+
export declare function copyTemplate(src: string, dest: string, values: Placeholders): string[];
|
|
16
|
+
/** True when the directory exists and contains anything. */
|
|
17
|
+
export declare function isNonEmptyDir(dir: string): boolean;
|
|
18
|
+
export declare function generateSecret(): string;
|
|
19
|
+
export declare function writeDevVars(dir: string, secret?: string): void;
|
|
20
|
+
/** Rewrites the `@kitcms/*` dependencies to `link:` paths of a local checkout. */
|
|
21
|
+
export declare function linkDependencies(dir: string, repo: string): void;
|
|
22
|
+
/** Replaces the D1 id placeholder in wrangler.jsonc. */
|
|
23
|
+
export declare function setDatabaseId(dir: string, id: string): void;
|
|
24
|
+
/** Lists leftover `__NAME__` placeholders in a scaffolded tree (for tests and sanity checks). */
|
|
25
|
+
export declare function findPlaceholders(dir: string): string[];
|
package/dist/scaffold.js
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { randomBytes } from 'node:crypto';
|
|
2
|
+
import fs from 'node:fs';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { fileURLToPath } from 'node:url';
|
|
5
|
+
/** Placeholders that may legitimately remain after scaffolding (none: the D1 id gets an explicit hint). */
|
|
6
|
+
export const DOCUMENTED_PLACEHOLDERS = [];
|
|
7
|
+
/** Files npm would strip or rename on publish are stored under a different name and restored here. */
|
|
8
|
+
const RENAMES = { _gitignore: '.gitignore' };
|
|
9
|
+
/** Package root: dist/ (or src/) sits one level below it. */
|
|
10
|
+
export function packageRoot() {
|
|
11
|
+
return path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
|
|
12
|
+
}
|
|
13
|
+
/** Published: `<pkg>/templates` (copied by `prepack`). Monorepo checkout: `<repo>/templates`. */
|
|
14
|
+
export function templatesDir(root = packageRoot()) {
|
|
15
|
+
for (const dir of [path.join(root, 'templates'), path.resolve(root, '../../templates')]) {
|
|
16
|
+
if (fs.existsSync(dir))
|
|
17
|
+
return dir;
|
|
18
|
+
}
|
|
19
|
+
throw new Error('kitcms templates not found');
|
|
20
|
+
}
|
|
21
|
+
export function toAppName(input) {
|
|
22
|
+
return (input
|
|
23
|
+
.trim()
|
|
24
|
+
.toLowerCase()
|
|
25
|
+
.replace(/[^a-z0-9]+/g, '-')
|
|
26
|
+
.replace(/^-+|-+$/g, '') || 'kitcms-app');
|
|
27
|
+
}
|
|
28
|
+
export function replacePlaceholders(text, values) {
|
|
29
|
+
let out = text;
|
|
30
|
+
for (const [k, v] of Object.entries(values))
|
|
31
|
+
out = out.split(k).join(v);
|
|
32
|
+
return out;
|
|
33
|
+
}
|
|
34
|
+
const SKIP = new Set(['node_modules', '.svelte-kit', '.wrangler', 'dist']);
|
|
35
|
+
export function copyTemplate(src, dest, values) {
|
|
36
|
+
const written = [];
|
|
37
|
+
const walk = (from, to, rel) => {
|
|
38
|
+
fs.mkdirSync(to, { recursive: true });
|
|
39
|
+
for (const entry of fs.readdirSync(from, { withFileTypes: true })) {
|
|
40
|
+
if (SKIP.has(entry.name))
|
|
41
|
+
continue;
|
|
42
|
+
const name = RENAMES[entry.name] ?? entry.name;
|
|
43
|
+
const target = path.join(to, name);
|
|
44
|
+
const relPath = rel ? `${rel}/${name}` : name;
|
|
45
|
+
if (entry.isDirectory())
|
|
46
|
+
walk(path.join(from, entry.name), target, relPath);
|
|
47
|
+
else {
|
|
48
|
+
fs.writeFileSync(target, replacePlaceholders(fs.readFileSync(path.join(from, entry.name), 'utf8'), values));
|
|
49
|
+
written.push(relPath);
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
walk(src, dest, '');
|
|
54
|
+
return written;
|
|
55
|
+
}
|
|
56
|
+
/** True when the directory exists and contains anything. */
|
|
57
|
+
export function isNonEmptyDir(dir) {
|
|
58
|
+
return fs.existsSync(dir) && fs.readdirSync(dir).length > 0;
|
|
59
|
+
}
|
|
60
|
+
export function generateSecret() {
|
|
61
|
+
return randomBytes(32).toString('base64url');
|
|
62
|
+
}
|
|
63
|
+
export function writeDevVars(dir, secret = generateSecret()) {
|
|
64
|
+
fs.writeFileSync(path.join(dir, '.dev.vars'), `BETTER_AUTH_SECRET=${secret}\n`);
|
|
65
|
+
}
|
|
66
|
+
/** Rewrites the `@kitcms/*` dependencies to `link:` paths of a local checkout. */
|
|
67
|
+
export function linkDependencies(dir, repo) {
|
|
68
|
+
const file = path.join(dir, 'package.json');
|
|
69
|
+
const pkg = JSON.parse(fs.readFileSync(file, 'utf8'));
|
|
70
|
+
const abs = path.resolve(repo);
|
|
71
|
+
for (const name of Object.keys(pkg.dependencies)) {
|
|
72
|
+
if (name.startsWith('@kitcms/'))
|
|
73
|
+
pkg.dependencies[name] = `link:${path.join(abs, 'packages', name.slice('@kitcms/'.length))}`;
|
|
74
|
+
}
|
|
75
|
+
fs.writeFileSync(file, JSON.stringify(pkg, null, '\t') + '\n');
|
|
76
|
+
}
|
|
77
|
+
/** Replaces the D1 id placeholder in wrangler.jsonc. */
|
|
78
|
+
export function setDatabaseId(dir, id) {
|
|
79
|
+
const file = path.join(dir, 'wrangler.jsonc');
|
|
80
|
+
fs.writeFileSync(file, fs.readFileSync(file, 'utf8').replace(/("database_id":\s*)"[^"]*"/, `$1"${id}"`));
|
|
81
|
+
}
|
|
82
|
+
/** Lists leftover `__NAME__` placeholders in a scaffolded tree (for tests and sanity checks). */
|
|
83
|
+
export function findPlaceholders(dir) {
|
|
84
|
+
const found = [];
|
|
85
|
+
const walk = (d) => {
|
|
86
|
+
for (const e of fs.readdirSync(d, { withFileTypes: true })) {
|
|
87
|
+
if (SKIP.has(e.name))
|
|
88
|
+
continue;
|
|
89
|
+
const p = path.join(d, e.name);
|
|
90
|
+
if (e.isDirectory())
|
|
91
|
+
walk(p);
|
|
92
|
+
else if (/__[A-Z_]+__/.test(fs.readFileSync(p, 'utf8')))
|
|
93
|
+
found.push(path.relative(dir, p));
|
|
94
|
+
}
|
|
95
|
+
};
|
|
96
|
+
walk(dir);
|
|
97
|
+
return found;
|
|
98
|
+
}
|
package/dist/wrangler.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** Extracts the D1 database id from `wrangler d1 create` output (JSON or TOML snippet). */
|
|
2
|
+
export function parseDatabaseId(output) {
|
|
3
|
+
const keyed = /["']?database_id["']?\s*[:=]\s*["']([^"']+)["']/.exec(output);
|
|
4
|
+
if (keyed?.[1])
|
|
5
|
+
return keyed[1];
|
|
6
|
+
return /\b[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\b/i.exec(output)?.[0];
|
|
7
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,37 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-kitcms",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Scaffold a kitcms app: pnpm create kitcms",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/Norden-Tenzin/kitcms.git",
|
|
9
|
+
"directory": "packages/create-kitcms"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://kitcms.dev",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/Norden-Tenzin/kitcms/issues"
|
|
14
|
+
},
|
|
15
|
+
"type": "module",
|
|
16
|
+
"exports": {
|
|
17
|
+
".": {
|
|
18
|
+
"types": "./dist/index.d.ts",
|
|
19
|
+
"default": "./dist/index.js"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"bin": {
|
|
23
|
+
"create-kitcms": "./bin/create.js"
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"bin",
|
|
27
|
+
"dist",
|
|
28
|
+
"templates"
|
|
29
|
+
],
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@types/node": "^26.6.6"
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"build": "tsc -p tsconfig.build.json",
|
|
35
|
+
"typecheck": "tsc --noEmit"
|
|
36
|
+
}
|
|
6
37
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
BETTER_AUTH_SECRET=
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# __APP_NAME__
|
|
2
|
+
|
|
3
|
+
A [kitcms](https://kitcms.dev) app: SvelteKit + Cloudflare Workers + D1 + R2.
|
|
4
|
+
|
|
5
|
+
> **Requires the Workers Paid plan to deploy.** Password hashing exceeds the Free plan's CPU limit.
|
|
6
|
+
|
|
7
|
+
## Setup
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
pnpm install
|
|
11
|
+
cp .dev.vars.example .dev.vars # then set BETTER_AUTH_SECRET (the scaffolder already did this)
|
|
12
|
+
pnpm db:generate init # generate the first migration from src/kitcms.config.ts
|
|
13
|
+
pnpm db:migrate # apply it to the local D1
|
|
14
|
+
pnpm dev
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Open <http://localhost:5173/admin>. The first visit asks you to create the first admin user.
|
|
18
|
+
|
|
19
|
+
## Schema and migrations
|
|
20
|
+
|
|
21
|
+
The schema is code: edit `src/kitcms.config.ts`, then `pnpm db:generate <name>` and `pnpm db:migrate`.
|
|
22
|
+
|
|
23
|
+
`src/kitcms.admin.ts` registers admin live previews (client-side, lazy). See `@kitcms/ui` "Live preview".
|
|
24
|
+
|
|
25
|
+
`pnpm types` regenerates the typed config declarations.
|
|
26
|
+
|
|
27
|
+
## Deploy
|
|
28
|
+
|
|
29
|
+
1. Create the resources if you have not (`wrangler d1 create __DB_NAME__`, `wrangler r2 bucket create __BUCKET_NAME__`) and put the D1 `database_id` into `wrangler.jsonc`.
|
|
30
|
+
2. `pnpm exec kitcms migrate --remote`
|
|
31
|
+
3. `pnpm exec wrangler secret put BETTER_AUTH_SECRET`
|
|
32
|
+
4. `pnpm run deploy`
|
|
33
|
+
|
|
34
|
+
`wrangler.jsonc` enables Smart Placement (the Worker runs near the D1 primary when that is faster). D1 read replication is optional and needs no code changes: turn it on in the Cloudflare dashboard (D1 → your database → Settings → Read replication). Visitors then read from the nearest replica, and signed-in editors still see their own saves. See the `@kitcms/core` README.
|
|
35
|
+
|
|
36
|
+
## Headless / RPC
|
|
37
|
+
|
|
38
|
+
`src/kitcms.rpc.ts` exports the `KitcmsRPC` entrypoint. Other Workers can bind to it with a Service Binding
|
|
39
|
+
(`"services": [{ "binding": "CMS", "service": "__APP_NAME__", "entrypoint": "KitcmsRPC" }]`) and read content over RPC.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "__APP_NAME__",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"private": true,
|
|
5
|
+
"type": "module",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"prepare": "svelte-kit sync",
|
|
8
|
+
"dev": "vite dev",
|
|
9
|
+
"build": "vite build",
|
|
10
|
+
"preview": "pnpm build && wrangler dev",
|
|
11
|
+
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
|
|
12
|
+
"deploy": "wrangler deploy",
|
|
13
|
+
"db:generate": "kitcms migrate:create",
|
|
14
|
+
"db:migrate": "kitcms migrate",
|
|
15
|
+
"types": "kitcms generate:types"
|
|
16
|
+
},
|
|
17
|
+
"dependencies": {
|
|
18
|
+
"@kitcms/core": "^0.1.0",
|
|
19
|
+
"@kitcms/ui": "^0.1.0"
|
|
20
|
+
},
|
|
21
|
+
"devDependencies": {
|
|
22
|
+
"@cloudflare/workers-types": "^5.20261116.1",
|
|
23
|
+
"@sveltejs/adapter-cloudflare": "^8.0.2",
|
|
24
|
+
"@sveltejs/kit": "^3.2.0",
|
|
25
|
+
"@sveltejs/vite-plugin-svelte": "^7.3.1",
|
|
26
|
+
"@types/node": "^26.6.6",
|
|
27
|
+
"svelte": "^5.57.3",
|
|
28
|
+
"svelte-check": "^4.7.8",
|
|
29
|
+
"typescript": "^6.0.3",
|
|
30
|
+
"vite": "^8.3.8",
|
|
31
|
+
"wrangler": "^4.162.0"
|
|
32
|
+
},
|
|
33
|
+
"imports": {
|
|
34
|
+
"#lib": "./src/lib/index.ts",
|
|
35
|
+
"#lib/*": "./src/lib/*"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
// See https://svelte.dev/docs/kit/types#app.d.ts
|
|
2
|
+
// Bindings come from `import { env } from 'cloudflare:workers'`, typed via Cloudflare.Env.
|
|
3
|
+
import type config from './kitcms.config';
|
|
4
|
+
|
|
5
|
+
declare module '@kitcms/core' {
|
|
6
|
+
interface Register {
|
|
7
|
+
config: typeof config;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
declare global {
|
|
12
|
+
namespace Cloudflare {
|
|
13
|
+
interface Env {
|
|
14
|
+
DB: D1Database;
|
|
15
|
+
BUCKET: R2Bucket;
|
|
16
|
+
/** Better Auth signing secret: `.dev.vars` locally, `wrangler secret put` when deployed. */
|
|
17
|
+
BETTER_AUTH_SECRET: string;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export {};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
+
%sveltekit.head%
|
|
7
|
+
</head>
|
|
8
|
+
<body data-sveltekit-preload-data="hover">
|
|
9
|
+
<div style="display: contents">%sveltekit.body%</div>
|
|
10
|
+
</body>
|
|
11
|
+
</html>
|