@veloxts/velox 0.6.23 → 0.6.26

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 +28 -3
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -6,13 +6,38 @@
6
6
 
7
7
  Full-stack TypeScript framework with end-to-end type safety—no code generation required. Convention-driven APIs that generate both tRPC and REST from a single source.
8
8
 
9
- ## Installation
9
+ ## Quick Start (Recommended)
10
10
 
11
11
  ```bash
12
- npm install @veloxts/velox
12
+ npx create-velox-app my-app
13
+ cd my-app
14
+ npm run db:push
15
+ npm run dev
13
16
  ```
14
17
 
15
- This single package includes everything you need to build VeloxTS applications.
18
+ Your API is running at `http://localhost:3030`.
19
+
20
+ ## Manual Installation
21
+
22
+ For adding to an existing project:
23
+
24
+ ```bash
25
+ npm install @veloxts/velox zod
26
+ npm install -D @veloxts/cli tsx typescript prisma @prisma/client
27
+ ```
28
+
29
+ Note: Manual setup requires Prisma 7 configuration with driver adapters. See [@veloxts/orm](https://www.npmjs.com/package/@veloxts/orm) for details.
30
+
31
+ ## What's Included
32
+
33
+ This umbrella package re-exports:
34
+ - `@veloxts/core` - App bootstrap, plugins, DI
35
+ - `@veloxts/validation` - Zod integration
36
+ - `@veloxts/orm` - Prisma database plugin
37
+ - `@veloxts/router` - Procedures, REST adapter, tRPC
38
+ - `@veloxts/auth` - Authentication & authorization
39
+
40
+ Separate packages: `@veloxts/cli`, `@veloxts/client`, `create-velox-app`
16
41
 
17
42
  ## License
18
43
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veloxts/velox",
3
- "version": "0.6.23",
3
+ "version": "0.6.26",
4
4
  "description": "Complete VeloxTS framework - batteries included",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -36,11 +36,11 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@veloxts/core": "0.6.23",
40
- "@veloxts/validation": "0.6.23",
41
- "@veloxts/router": "0.6.23",
42
- "@veloxts/auth": "0.6.23",
43
- "@veloxts/orm": "0.6.23"
39
+ "@veloxts/core": "0.6.26",
40
+ "@veloxts/validation": "0.6.26",
41
+ "@veloxts/orm": "0.6.26",
42
+ "@veloxts/router": "0.6.26",
43
+ "@veloxts/auth": "0.6.26"
44
44
  },
45
45
  "devDependencies": {
46
46
  "typescript": "5.9.3"