@zintrust/core 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,214 @@
+# Getting Started with Zintrust
+
+Welcome to Zintrust, a production-grade TypeScript backend framework with proven architectural patterns and zero external dependencies.
+
+## Quick Start (2 minutes)
+
+```bash
+# Install @zintrust/core (Zintrust CLI)
+npm install -g @zintrust/core
+
+# Create a new project
+zin new my-app
+cd my-app
+
+# Start development
+npm run dev
+```
+
+Your API is now running at `http://localhost:3000`
+
+## What is Zintrust?
+
+Zintrust is a **zero-dependency** backend framework built on:
+
+- ✅ **Pure Node.js** - No Express, Fastify, or external HTTP libraries
+- ✅ **Type-Safe** - Strict TypeScript with 100% type coverage
+- ✅ **Microservices** - Built-in service discovery and orchestration
+- ✅ **Production Ready** - Used in high-traffic applications
+
+## Key Features
+
+### 🚀 Blazing Fast
+
+- Native HTTP server - No framework overhead
+- Type-safe queries with automatic SQL injection prevention
+- Efficient memory management with built-in profiling
+
+### 🛡️ Secure by Default
+
+- No raw SQL - QueryBuilder enforces parameterized queries
+- Automatic CSRF protection
+- JWT token management
+- XSS vulnerability prevention
+
+### 📊 Observable
+
+- Built-in N+1 query detection
+- Memory profiling per request
+- Request tracing across microservices
+- File-based logging system
+
+### 🔧 Developer Friendly
+
+- Modern Active Record ORM
+- Fluent routing API with middleware
+- CLI scaffolding (models, migrations, controllers)
+- Comprehensive testing utilities
+
+## Installation
+
+### Prerequisites
+
+- Node.js >= 20.0.0
+- Any npm-compatible package manager (npm, yarn, pnpm, bun)
+
+### From npm (Recommended)
+
+Zintrust is distributed on npm as `@zintrust/core`.
+
+```bash
+npm install -g @zintrust/core
+zin new my-app
+```
+
+You can install it with any npm-compatible package manager:
+
+```bash
+# npm
+npm install -g @zintrust/core
+
+# yarn
+yarn global add @zintrust/core
+
+# pnpm
+pnpm add -g @zintrust/core
+
+# bun
+bun add -g @zintrust/core
+```
+
+### From source
+
+```bash
+git clone https://github.com/ZinTrust/ZinTrust.git
+cd ZinTrust
+npm install
+npm run build
+```
+
+## Create Your First API
+
+### 1. Define a Model
+
+```typescript
+// app/Models/User.ts
+import { Model } from '@zintrust/core';
+
+export const User = Model.define({
+  table: 'users',
+  fillable: ['name', 'email', 'password'],
+  hidden: ['password'],
+  timestamps: true,
+  casts: {
+    is_admin: 'boolean',
+  },
+});
+```
+
+### 2. Create a Route
+
+```typescript
+// routes/api.ts
+import { Application } from '@zintrust/core';
+import { User } from '@app/Models/User';
+
+export function registerRoutes(app: Application): void {
+  const router = app.getRouter();
+
+  // Get all users
+  router.get('/api/users', async (req, res) => {
+    const users = await User.all();
+    res.json({ data: users });
+  });
+
+  // Get user by ID
+  router.get('/api/users/:id', async (req, res) => {
+    const user = await User.find(req.getParam('id'));
+    if (!user) {
+      return res.setStatus(404).json({ error: 'User not found' });
+    }
+    res.json({ data: user });
+  });
+
+  // Create user
+  router.post('/api/users', async (req, res) => {
+    const user = await User.create(req.getBody());
+    res.setStatus(201).json({ data: user });
+  });
+}
+```
+
+### 3. Run Your API
+
+```bash
+npm run dev
+```
+
+Test it:
+
+```bash
+# Get all users
+curl http://localhost:3000/api/users
+
+# Create a user
+curl -X POST http://localhost:3000/api/users \
+  -H "Content-Type: application/json" \
+  -d '{"name":"John","email":"john@example.com"}'
+```
+
+## Next Steps
+
+- 📖 [Models & ORM](https://zintrust.com/doc/models) - Database patterns and relationships
+- 🛣️ [Routing](https://zintrust.com/doc/routing) - HTTP routing and middleware
+- 🏗️ [Microservices](https://zintrust.com/doc/microservices) - Build distributed systems
+- ⚙️ [CLI Commands](https://zintrust.com/doc/cli-reference) - Code generation and management
+- 📝 [API Reference](https://zintrust.com/doc/api-reference) - Complete API documentation
+
+## Architecture Overview
+
+Zintrust uses a proven layered architecture:
+
+```
+┌─────────────────────────────────┐
+│      HTTP Request/Response      │
+├─────────────────────────────────┤
+│      Router (URL Matching)      │
+├─────────────────────────────────┤
+│    Middleware Pipeline          │
+├─────────────────────────────────┤
+│    Controllers/Handlers         │
+├─────────────────────────────────┤
+│    Service Layer                │
+├─────────────────────────────────┤
+│    ORM Models                   │
+├─────────────────────────────────┤
+│    QueryBuilder (Type-Safe SQL) │
+├─────────────────────────────────┤
+│    Database Adapter             │
+├─────────────────────────────────┤
+│    Native Database Driver       │
+└─────────────────────────────────┘
+```
+
+## Community & Support
+
+- 📚 [Documentation](https://zintrust.com)
+- 💬 [Discord Community](https://discord.gg/zintrust)
+- 🐦 [Follow on X](https://x.com/zintrust)
+- 🐛 [Issue Tracker](https://github.com/ZinTrust/ZinTrust/issues)
+- 🤝 [Contributing Guide](./contributing.md)
+
+## License
+
+MIT - See [LICENSE](../LICENSE) for details

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@zintrust/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Production-grade TypeScript backend framework for JavaScript",
   "homepage": "https://zintrust.com",
-  "private": false,
   "repository": {
     "type": "git",
     "url": "https://github.com/ZinTrust/ZinTrust.git"
@@ -22,7 +21,8 @@
   },
   "files": [
     "bin",
-    "src"
+    "src",
+    "public"
   ],
   "engines": {
     "node": ">=20.0.0",
@@ -46,35 +46,5 @@
   "license": "MIT",
   "publishConfig": {
     "access": "public"
-  },
-  "dependencies": {
-    "bcrypt": "^6.0.0",
-    "better-sqlite3": "^12.5.0",
-    "chalk": "^5.6.2",
-    "commander": "^14.0.2",
-    "inquirer": "^13.1.0",
-    "jsonwebtoken": "^9.0.3",
-    "tsx": "^4.21.0"
-  },
-  "devDependencies": {
-    "@codecov/vite-plugin": "^1.9.1",
-    "@resvg/resvg-js": "^2.6.2",
-    "@types/bcrypt": "^6.0.0",
-    "@types/better-sqlite3": "7.6.13",
-    "@types/jsonwebtoken": "^9.0.10",
-    "@types/node": "^25.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.50.0",
-    "@typescript-eslint/parser": "^8.50.0",
-    "@vitest/coverage-v8": "^4.0.16",
-    "eslint": "^9.39.2",
-    "globals": "^16.5.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.2.7",
-    "prettier": "^3.7.4",
-    "sonarqube-scanner": "^4.3.2",
-    "tsc-alias": "^1.8.16",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.50.0",
-    "vitest": "^4.0.16"
   }
-}
+}