wuppycms 0.2.1 → 0.2.2
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 +69 -0
- package/package.json +24 -6
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# wuppycms
|
|
2
|
+
|
|
3
|
+
A file-based, Git-backed CMS for [Astro](https://astro.build). WuppyCMS adds an admin panel to your Astro site: content
|
|
4
|
+
stays in Markdown and MDX files in your repository, every save is a Git commit, and editors get a visual editor.
|
|
5
|
+
|
|
6
|
+
## Start a new site
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
npm create wuppycms my-site
|
|
10
|
+
cd my-site
|
|
11
|
+
npm install
|
|
12
|
+
npm run dev
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Open `http://localhost:4321/admin` and create the first account.
|
|
16
|
+
|
|
17
|
+
## Add it to an existing Astro site
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npm install wuppycms
|
|
21
|
+
npx wuppycms init
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
`wuppycms init` finds your content collections, writes `wuppy.config.mjs` and adds the integration:
|
|
25
|
+
|
|
26
|
+
```js
|
|
27
|
+
// astro.config.mjs
|
|
28
|
+
import { defineConfig } from "astro/config";
|
|
29
|
+
import wuppycms from "wuppycms/astro";
|
|
30
|
+
|
|
31
|
+
export default defineConfig({
|
|
32
|
+
integrations: [wuppycms()],
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Use content in templates
|
|
37
|
+
|
|
38
|
+
```astro
|
|
39
|
+
---
|
|
40
|
+
import { getMenu, readData } from "wuppycms";
|
|
41
|
+
const menu = await getMenu("main");
|
|
42
|
+
---
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## What you get
|
|
46
|
+
|
|
47
|
+
- Collections and fields from `wuppy.config.mjs`; forms are built from them
|
|
48
|
+
- Revisions, diffs and restore from Git history
|
|
49
|
+
- A visual editor for blocks and for your theme's own markup
|
|
50
|
+
- Users and roles, two-factor sign-in, passkeys and a security log
|
|
51
|
+
- Media with focal points and crops, menus, redirects, SEO and sitemaps
|
|
52
|
+
- Plugins in a WebAssembly sandbox, webhooks, an AI assistant and managed sites
|
|
53
|
+
|
|
54
|
+
## CLI
|
|
55
|
+
|
|
56
|
+
| Command | Does |
|
|
57
|
+
| --- | --- |
|
|
58
|
+
| `wuppycms init` | wrap an existing Astro project |
|
|
59
|
+
| `wuppycms upgrade` | migrate project data after updating the package |
|
|
60
|
+
| `wuppycms types` | generate TypeScript types for your collections |
|
|
61
|
+
| `wuppycms doctor` | check the setup |
|
|
62
|
+
|
|
63
|
+
Requires Node.js 22.16 or later and Astro 7.4 or later.
|
|
64
|
+
|
|
65
|
+
## Links
|
|
66
|
+
|
|
67
|
+
- Website: [wuppycms.com](https://wuppycms.com)
|
|
68
|
+
- Documentation: [docs.wuppycms.com](https://docs.wuppycms.com)
|
|
69
|
+
- Source: [GitHub](https://github.com/fuatcangnc/wuppy)
|
package/package.json
CHANGED
|
@@ -1,6 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "wuppycms",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
|
+
"description": "WuppyCMS: a file-based, Git-backed CMS and admin panel for Astro.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"astro",
|
|
7
|
+
"astro-integration",
|
|
8
|
+
"cms",
|
|
9
|
+
"headless-cms",
|
|
10
|
+
"markdown",
|
|
11
|
+
"mdx",
|
|
12
|
+
"git",
|
|
13
|
+
"withastro"
|
|
14
|
+
],
|
|
15
|
+
"homepage": "https://wuppycms.com",
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "git+https://github.com/fuatcangnc/wuppy.git",
|
|
19
|
+
"directory": "packages/core"
|
|
20
|
+
},
|
|
21
|
+
"bugs": "https://github.com/fuatcangnc/wuppy/issues",
|
|
4
22
|
"type": "module",
|
|
5
23
|
"exports": {
|
|
6
24
|
".": {
|
|
@@ -40,11 +58,11 @@
|
|
|
40
58
|
"resend": "^6.34.1",
|
|
41
59
|
"yaml": "^2.8.0",
|
|
42
60
|
"zod": "4.5.4",
|
|
43
|
-
"@wuppycms/admin": "0.2.
|
|
44
|
-
"@wuppycms/
|
|
45
|
-
"@wuppycms/
|
|
46
|
-
"@wuppycms/plugin-types": "0.2.
|
|
47
|
-
"@wuppycms/visual-editor": "0.2.
|
|
61
|
+
"@wuppycms/admin": "0.2.2",
|
|
62
|
+
"@wuppycms/auth": "0.2.2",
|
|
63
|
+
"@wuppycms/git": "0.2.2",
|
|
64
|
+
"@wuppycms/plugin-types": "0.2.2",
|
|
65
|
+
"@wuppycms/visual-editor": "0.2.2"
|
|
48
66
|
},
|
|
49
67
|
"devDependencies": {
|
|
50
68
|
"@types/node": "^22.16.0",
|