cabloy 5.1.157 → 5.1.158
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/.cabloy-version +1 -1
- package/CHANGELOG.md +7 -0
- package/CONTRIBUTING.md +84 -0
- package/LICENSES.md +5 -0
- package/package.json +1 -1
package/.cabloy-version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
5.1.
|
|
1
|
+
5.1.158
|
package/CHANGELOG.md
CHANGED
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Contributing to Cabloy Basic
|
|
2
|
+
|
|
3
|
+
Contributions to Cabloy Basic source, tests, tooling, and documentation are welcome. Cabloy Basic is the public Cabloy framework/reference edition, with Vona backend and Zova frontend layers.
|
|
4
|
+
|
|
5
|
+
## Before you begin
|
|
6
|
+
|
|
7
|
+
- Use [GitHub Issues](https://github.com/cabloy/cabloy/issues) for reproducible bugs, public questions, and feature proposals. Search for an existing issue first.
|
|
8
|
+
- Use [pull requests](https://github.com/cabloy/cabloy/pulls) for focused, reviewable changes.
|
|
9
|
+
- For a bug report, include the expected and actual behavior, a minimal reproduction or sufficient setup details, and relevant Cabloy, Node.js, pnpm, database, and browser/runtime versions.
|
|
10
|
+
- Remove credentials, tokens, personal data, and sensitive system information from issues, logs, screenshots, and pull requests.
|
|
11
|
+
|
|
12
|
+
## Set up a development checkout
|
|
13
|
+
|
|
14
|
+
You need Git, Node.js `>=24.4.0`, pnpm `>=11.5.2`, Redis `>=7.2.6`, and one documented development database baseline: SQLite, MySQL `>=8`, or PostgreSQL `>=16`. SQLite setups using `better-sqlite3` may also require a native build toolchain for `node-gyp`.
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
git clone https://github.com/cabloy/cabloy.git
|
|
18
|
+
cd cabloy
|
|
19
|
+
npm run init
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
`npm run init` is more than a package install: it installs multiple workspaces, prepares generated local configuration, initializes and synchronizes Vona and Zova, and generates required frontend and backend artifacts. Run it intentionally rather than as a retry for an unrelated narrow change.
|
|
23
|
+
|
|
24
|
+
Current CI workflows run on Ubuntu with Node.js 24 after pushes to `main`; do not assume that every pull request is automatically validated. For maintained onboarding guidance, see [Cabloy Basic](https://cabloy.com/editions/cabloy-basic).
|
|
25
|
+
|
|
26
|
+
## Develop and validate
|
|
27
|
+
|
|
28
|
+
Start with the narrowest meaningful check, then broaden validation when a change crosses a shared boundary.
|
|
29
|
+
|
|
30
|
+
| Purpose | Command |
|
|
31
|
+
| ---------------------------------------- | -------------------------- |
|
|
32
|
+
| Start Vona development | `npm run dev` |
|
|
33
|
+
| Start one Vona development process | `npm run dev:one` |
|
|
34
|
+
| Start Basic Admin SSR development | `npm run dev:zova:admin` |
|
|
35
|
+
| Start Basic Web SSR development | `npm run dev:zova:web` |
|
|
36
|
+
| Check formatting | `npm run format` |
|
|
37
|
+
| Lint | `npm run lint` |
|
|
38
|
+
| Type-check Vona and Zova | `npm run tsc` |
|
|
39
|
+
| Run backend tests | `npm run test` |
|
|
40
|
+
| Run the full E2E suite | `npm run test:e2e` |
|
|
41
|
+
| Rerun E2E tests without reset | `npm run test:e2e:fast` |
|
|
42
|
+
| Build required Basic artifacts | `npm run build` |
|
|
43
|
+
| Build Basic Admin SSR and REST artifacts | `npm run build:zova:admin` |
|
|
44
|
+
| Build Basic Web SSR and REST artifacts | `npm run build:zova:web` |
|
|
45
|
+
| Synchronize Zova dependencies into Vona | `npm run deps:vona` |
|
|
46
|
+
| Build the public documentation site | `npm run docs:build` |
|
|
47
|
+
|
|
48
|
+
The tracked pre-commit hook runs `lint-staged`. It may format staged Markdown and configuration files, and may lint-fix and format staged source files. Review the resulting staged changes and run the relevant explicit checks before submitting.
|
|
49
|
+
|
|
50
|
+
## Generated code and Vona–Zova integration
|
|
51
|
+
|
|
52
|
+
Use Vona backend contracts, DTOs, OpenAPI metadata, and schema metadata as contract truth. Regenerate consumers rather than hand-editing generated frontend artifacts.
|
|
53
|
+
|
|
54
|
+
For frontend metadata or dependency changes that Vona consumes, build every affected Basic flavor before synchronizing dependencies:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npm run build:zova:admin
|
|
58
|
+
# Also run npm run build:zova:web when Web is affected.
|
|
59
|
+
npm run deps:vona
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Keep SSR and REST outputs aligned; a REST-only build is not sufficient. See the canonical [Contract Loop Playbook](https://cabloy.com/fullstack/contract-loop-playbook), [Vona + Zova Integration](https://cabloy.com/fullstack/vona-zova-integration), and [repository scripts reference](https://cabloy.com/reference/repo-scripts).
|
|
63
|
+
|
|
64
|
+
## Pull requests
|
|
65
|
+
|
|
66
|
+
Keep each pull request focused and describe its user-visible and technical effects. Include:
|
|
67
|
+
|
|
68
|
+
- the related issue when one exists;
|
|
69
|
+
- tests added or updated for behavioral changes;
|
|
70
|
+
- the exact validation commands run and their results;
|
|
71
|
+
- any regenerated contract artifacts and the build/synchronization steps used; and
|
|
72
|
+
- documentation updates, or why no documentation update is needed.
|
|
73
|
+
|
|
74
|
+
Do not include unrelated generated output, build artifacts, environment files, credentials, or cache files.
|
|
75
|
+
|
|
76
|
+
## Documentation
|
|
77
|
+
|
|
78
|
+
Canonical public Cabloy documentation is maintained in this repository's `repo-docs/` tree and published at [cabloy.com](https://cabloy.com). Discuss and submit proposed public-documentation changes in an issue or pull request; do not treat copies outside this repository as independent canonical sources.
|
|
79
|
+
|
|
80
|
+
## License and contribution rights
|
|
81
|
+
|
|
82
|
+
Cabloy Basic project-owned content is licensed under the root [MIT License](./LICENSE).
|
|
83
|
+
|
|
84
|
+
Submit only material that you have the right to contribute. Preserve required copyright, license, attribution, and third-party notices for any included code, media, fonts, generated material, or copied snippets.
|
package/LICENSES.md
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# License Scope
|
|
2
|
+
|
|
3
|
+
Unless a file or directory includes its own complete license or third-party notice, Cabloy Basic project-owned source, documentation, and assets inherit the root [MIT License](./LICENSE).
|
|
4
|
+
|
|
5
|
+
Third-party material remains subject to the license and notice provided with that material or otherwise required by its upstream terms.
|