@tobi2409/fullsty 0.8.0 → 0.8.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.
Files changed (2) hide show
  1. package/README.md +16 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,15 +4,19 @@ ROADMAP: Platform-Independency (generate Fullsty-App as Web-App, Mobile-App, Win
4
4
 
5
5
  Fullsty is a modular fullstack framework starter built from three core parts:
6
6
 
7
- - `template-engine` for reactive UI rendering
8
- - `layout` for lightweight CSS layout composition
9
- - `proc2rest` for generating REST server/client code from TypeScript server functions
7
+ - `@tobi2409/mvvm-monster` for reactive UI rendering
8
+ - `@tobi2409/layout` for lightweight CSS layout composition
9
+ - `@tobi2409/proc2rest` for generating REST server/client code from TypeScript server functions
10
10
 
11
11
  This repository provides a project template and scaffolding script so you can create a new project, generate API/client artifacts, and run the generated server quickly.
12
12
 
13
- Minimal Fullsty starter workflow.
13
+ ## Installation
14
14
 
15
- **It is recommended to install fullsty globally.**
15
+ Install Fullsty globally:
16
+
17
+ ```bash
18
+ npm install --global @tobi2409/fullsty
19
+ ```
16
20
 
17
21
  A sample application can be found at https://github.com/tobi2409/fullsty/tree/main/projects/db-test
18
22
 
@@ -26,7 +30,7 @@ fullsty-server-pkg add drizzle
26
30
 
27
31
  ## 1) Create a project
28
32
 
29
- From the repository root:
33
+ Create a project in the desired parent directory:
30
34
 
31
35
  ```bash
32
36
  create-fullsty-project projects/demo1
@@ -58,9 +62,9 @@ This runs:
58
62
 
59
63
  It also copies [project-frame/server-package.json](project-frame/server-package.json) to `generated/server/package.json` and [project-frame/client-package.json](project-frame/client-package.json) to `generated/client/package.json`.
60
64
 
61
- ## 4) Use `fullsty-pkg` for wrapper packages
65
+ ## 4) Use `fullsty-server-pkg` for wrapper packages
62
66
 
63
- `fullsty-pkg.js` is a small project helper for wrapper-aware package changes.
67
+ `fullsty-server-pkg` is a project helper for wrapper-aware server package changes.
64
68
 
65
69
  Run it from the project root, for example:
66
70
 
@@ -70,7 +74,7 @@ fullsty-server-pkg add drizzle
70
74
  fullsty-server-pkg remove pg
71
75
  ```
72
76
 
73
- Alternatively, you can also use `npx fullsty-server-pkg`.
77
+ Alternatively, run it through the Fullsty package with `npx --package @tobi2409/fullsty fullsty-server-pkg`.
74
78
 
75
79
  What it does:
76
80
 
@@ -88,9 +92,9 @@ copied files under `src/server` and the generated files under `generated/server`
88
92
  are derived artifacts and should not be edited manually. Re-run the wrapper
89
93
  command and `npm run generate` after changing an extension or its dependencies.
90
94
 
91
- After `fullsty-server-pkg.js add <package>` you should run `npm run generate` again so the updated project server package file is copied into `generated/server/package.json`. After that, run `npm install` again inside [projects/demo1/generated/server](projects/demo1/generated/server) so the generated server gets the updated dependencies.
95
+ After `fullsty-server-pkg add <package>` you should run `npm run generate` again so the updated project server package file is copied into `generated/server/package.json`. After that, run `npm install` again inside [projects/demo1/generated/server](projects/demo1/generated/server) so the generated server gets the updated dependencies.
92
96
 
93
- `fullsty-server-pkg.js add drizzle` copies [scripts/extension-wrappers/drizzle/drizzle-wrapper.ts](scripts/extension-wrappers/drizzle/drizzle-wrapper.ts) into [projects/demo1/src/server](projects/demo1/src/server). This keeps Drizzle visible as the recommended SQL style without coupling it to a specific DBMS wrapper. For PostgreSQL pooling and env handling you can add `pg` separately.
97
+ `fullsty-server-pkg add drizzle` copies [scripts/extension-wrappers/drizzle/drizzle-wrapper.ts](scripts/extension-wrappers/drizzle/drizzle-wrapper.ts) into [projects/demo1/src/server](projects/demo1/src/server). This keeps Drizzle visible as the recommended SQL style without coupling it to a specific DBMS wrapper. For PostgreSQL pooling and env handling you can add `pg` separately.
94
98
 
95
99
  ## 5) Start the generated server
96
100
 
@@ -134,7 +138,7 @@ To prevent Live Server from reloading when server logs are written, add this to
134
138
 
135
139
  ## Quick summary
136
140
 
137
- 1. `node create-project.js projects/<project-name>`
141
+ 1. `create-fullsty-project projects/<project-name>`
138
142
  2. `cd projects/<project-name>`
139
143
  3. `npm install`
140
144
  4. `npm run generate`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tobi2409/fullsty",
3
- "version": "0.8.0",
3
+ "version": "0.8.1",
4
4
  "description": "Fullsty is a modular fullstack framework starter built from three core parts: template-engine, layout and proc2rest. It provides a project frame for building fullstack applications with a clear separation of client and server code.",
5
5
  "license": "ISC",
6
6
  "author": "Tobias Hollstein",