habarico 7.3.0-beta.3 → 7.3.0-beta.4
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 +2 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ or 19.
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
|
|
14
|
+
npm install habarico
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
Peer dependencies (React, React Admin, MUI) are not bundled — install them in the project at the
|
|
@@ -21,28 +21,6 @@ same versions the library declares.
|
|
|
21
21
|
> data router. Let `SchemaAdmin` create one itself, or wrap it in `createBrowserRouter` — a legacy
|
|
22
22
|
> `<BrowserRouter>` silently disables the guard.
|
|
23
23
|
|
|
24
|
-
## Local development against a checkout
|
|
25
|
-
|
|
26
|
-
To run a project against your working copy instead of the published package, link it from the
|
|
27
|
-
project directory — the free library first, the paid one second:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
pydev link-library <path-to-libs>/habarico-base/node <path-to-libs>/habarico-enterprise/node-enterprise
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
`<path-to-libs>` is the directory holding your library checkouts — the same placeholder the Ruby services use in their compose files. Relative or absolute, both work.
|
|
34
|
-
|
|
35
|
-
Link only what you develop; either package works on its own. When you link both, the order matters —
|
|
36
|
-
`habarico-enterprise` resolves its own `habarico` through the project, so the free library
|
|
37
|
-
has to be linked first or both end up with their own copy of React.
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
pnpm watch # in the library you edit
|
|
41
|
-
pydev unlink-library <same paths>
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
See [Installation](https://docs.habarico.com/node/installation) for the details.
|
|
45
|
-
|
|
46
24
|
## Quick start
|
|
47
25
|
|
|
48
26
|
```tsx
|
|
@@ -77,7 +55,7 @@ is only a quick start.
|
|
|
77
55
|
|
|
78
56
|
| Section | What it covers |
|
|
79
57
|
| --- | --- |
|
|
80
|
-
| [Installation](https://docs.habarico.com/node/installation) |
|
|
58
|
+
| [Installation](https://docs.habarico.com/node/installation) | Peer dependencies and the router requirement |
|
|
81
59
|
| [Base components](https://docs.habarico.com/node/base-components/) | `SchemaAdmin` and `SchemaResource` — every prop |
|
|
82
60
|
| [View components](https://docs.habarico.com/node/view-components/) | List, show, create, edit and action views |
|
|
83
61
|
| [Providers](https://docs.habarico.com/node/providers/) | Auth, data and schema providers, and the customisation registries |
|
|
@@ -91,10 +69,6 @@ The backends serving those schemas are documented at
|
|
|
91
69
|
[docs.habarico.com/ruby/intro](https://docs.habarico.com/ruby/intro); the contract between them is the
|
|
92
70
|
[API reference](https://docs.habarico.com/api).
|
|
93
71
|
|
|
94
|
-
The architecture of the library itself — its four layers and what belongs where — is documented in
|
|
95
|
-
`src/foundation/README.md`, `src/design/README.md`, `src/admin/README.md` and
|
|
96
|
-
`src/schema/README.md`, next to the code they describe.
|
|
97
|
-
|
|
98
72
|
## License
|
|
99
73
|
|
|
100
74
|
[MIT](LICENSE)
|
package/package.json
CHANGED