@yunsoft/yuncms 0.1.10 → 0.1.11
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 +24 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -2,12 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
Command-line setup, runtime launcher and guarded upgrade tooling for YunCMS.
|
|
4
4
|
|
|
5
|
+
## Quick start
|
|
6
|
+
|
|
7
|
+
You do **not** need to clone or fork the YunCMS repository. From an empty project directory, run the published package directly:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
mkdir my-yuncms
|
|
11
|
+
cd my-yuncms
|
|
12
|
+
npx --yes @yunsoft/yuncms init
|
|
13
|
+
npx --yes @yunsoft/yuncms start
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
`init` creates the project `.env`, asks for MySQL connection details, applies the required database migrations and creates the first Administrator account.
|
|
17
|
+
|
|
18
|
+
The current directory is used as the YunCMS project directory, including local Files and local `extensions/`.
|
|
19
|
+
|
|
20
|
+
## Persistent project dependency
|
|
21
|
+
|
|
22
|
+
For a long-lived installation that should keep YunCMS in its own `package.json` and use managed updates, install the package once:
|
|
23
|
+
|
|
5
24
|
```bash
|
|
25
|
+
npm init -y
|
|
6
26
|
npm install @yunsoft/yuncms
|
|
7
27
|
npx yuncms init
|
|
8
28
|
npx yuncms start
|
|
9
29
|
```
|
|
10
30
|
|
|
31
|
+
Once installed locally, `npx yuncms ...` resolves the project's pinned package version.
|
|
32
|
+
|
|
11
33
|
Production maintenance commands:
|
|
12
34
|
|
|
13
35
|
```bash
|
|
@@ -21,10 +43,10 @@ npx yuncms restore /path/to/backup --yes
|
|
|
21
43
|
|
|
22
44
|
S3 objects are not copied by YunCMS backup; use provider-side versioning/snapshots and verify recovery before acknowledging an S3 update.
|
|
23
45
|
|
|
24
|
-
YunCMS requires Node.js 24 LTS and MySQL
|
|
46
|
+
YunCMS requires Node.js 24 LTS and MySQL. See the [project documentation](https://github.com/Yunsoft-Software/yuncms#documentation), [`docs/setup-cli.md`](https://github.com/Yunsoft-Software/yuncms/blob/main/docs/setup-cli.md) and [`docs/upgrades.md`](https://github.com/Yunsoft-Software/yuncms/blob/main/docs/upgrades.md) for setup, deployment and upgrade documentation.
|
|
25
47
|
|
|
26
48
|
## Project status
|
|
27
49
|
|
|
28
50
|
YunCMS is developed and maintained by [Yunsoft Software](https://yunsoft.com). It is under active development, so interfaces and behavior may change between releases. Test upgrades and keep verified backups before production use.
|
|
29
51
|
|
|
30
|
-
Use YunCMS at your own risk. This package is provided under the [MIT License](https://github.com/Yunsoft-Software/yuncms/blob/
|
|
52
|
+
Use YunCMS at your own risk. This package is provided under the [MIT License](https://github.com/Yunsoft-Software/yuncms/blob/main/LICENSE) without warranty.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yunsoft/yuncms",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.11",
|
|
4
4
|
"description": "Command-line setup and runtime launcher for YunCMS.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"test": "node --test"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@yunsoft/yuncms-api": "0.1.
|
|
34
|
-
"@yunsoft/yuncms-core": "0.1.
|
|
33
|
+
"@yunsoft/yuncms-api": "0.1.11",
|
|
34
|
+
"@yunsoft/yuncms-core": "0.1.11"
|
|
35
35
|
}
|
|
36
36
|
}
|