create-indiepub 0.0.0 → 0.1.1
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 +72 -0
- package/dist/index.js +0 -1
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# create-indiepub
|
|
2
|
+
|
|
3
|
+
Scaffold a new [IndiePub](https://indiepub.dev) site in seconds. Clones an official theme from Codeberg, wires up your config, and gets you ready to deploy on Cloudflare.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm create indiepub
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or with pnpm / yarn:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm create indiepub
|
|
15
|
+
yarn create indiepub
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
The interactive CLI will walk you through:
|
|
19
|
+
|
|
20
|
+
1. **Project directory** — where to create your site
|
|
21
|
+
2. **Template** — choose a theme:
|
|
22
|
+
- **Default** — dev-focused IndieWeb site with all post types
|
|
23
|
+
- **Byline** — writer-focused blog with TipTap editor and /write dashboard
|
|
24
|
+
- **Timeline** — feed-based social profile with unified timeline
|
|
25
|
+
- **Minimal** — bare config, bring your own pages
|
|
26
|
+
3. **Site details** — title, author name, URL
|
|
27
|
+
4. **License token** — your IndiePub license key (from [indiepub.dev/account](https://indiepub.dev/account))
|
|
28
|
+
5. **Syndication** — optionally enable Bluesky and/or Mastodon cross-posting
|
|
29
|
+
6. **Email subscriptions** — optionally enable newsletter support
|
|
30
|
+
|
|
31
|
+
## What you get
|
|
32
|
+
|
|
33
|
+
A ready-to-deploy Astro project configured for Cloudflare Pages with:
|
|
34
|
+
|
|
35
|
+
- Pre-configured `.npmrc` pointing at the IndiePub package registry
|
|
36
|
+
- `wrangler.toml` with D1, R2, and KV bindings
|
|
37
|
+
- `.dev.vars.example` with the secrets you'll need
|
|
38
|
+
- Optional GitHub Actions deploy workflow
|
|
39
|
+
|
|
40
|
+
## After scaffolding
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
cd my-site
|
|
44
|
+
cp .dev.vars.example .dev.vars # add your secrets
|
|
45
|
+
|
|
46
|
+
# Create your Cloudflare D1 database
|
|
47
|
+
npx wrangler d1 create my-site-db
|
|
48
|
+
# Copy the database_id into wrangler.toml
|
|
49
|
+
|
|
50
|
+
pnpm install
|
|
51
|
+
pnpm db:migrate
|
|
52
|
+
pnpm dev
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Then visit `/admin/onboarding` to finish setup.
|
|
56
|
+
|
|
57
|
+
## Requirements
|
|
58
|
+
|
|
59
|
+
- Node.js >= 20
|
|
60
|
+
- A Cloudflare account (free tier works)
|
|
61
|
+
- An IndiePub license token
|
|
62
|
+
|
|
63
|
+
## Links
|
|
64
|
+
|
|
65
|
+
- [IndiePub](https://indiepub.dev) — project homepage
|
|
66
|
+
- [Documentation](https://indiepub.dev/docs) — full guides and API reference
|
|
67
|
+
- [Themes](https://codeberg.org/indiepub/themes) — theme source code
|
|
68
|
+
- [Source](https://codeberg.org/indiepub/create-indiepub) — this package
|
|
69
|
+
|
|
70
|
+
## License
|
|
71
|
+
|
|
72
|
+
[FSL-1.1-ALv2](LICENSE) — Functional Source License, converting to Apache 2.0 after two years.
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-indiepub",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"bin": {
|
|
6
6
|
"create-indiepub": "./dist/index.js"
|
|
@@ -31,4 +31,4 @@
|
|
|
31
31
|
"astro"
|
|
32
32
|
],
|
|
33
33
|
"packageManager": "pnpm@10.30.3+sha512.c961d1e0a2d8e354ecaa5166b822516668b7f44cb5bd95122d590dd81922f606f5473b6d23ec4a5be05e7fcd18e8488d47d978bbe981872f1145d06e9a740017"
|
|
34
|
-
}
|
|
34
|
+
}
|