dolphin-server-modules 1.0.4 → 1.0.5

package/README.md

@@ -21,6 +21,53 @@ npm install dolphin-server-modules
 
 ---
 
+## 🚀 Quick Start (Complete Tutorial)
+
+Building a high-performance API with Dolphin is simple. Here is a full example:
+
+### 1. Define your Database (Mongoose)
+```typescript
+import mongoose from 'mongoose';
+import { createMongooseAdapter } from 'dolphin-server-modules/adapters/mongoose';
+
+const User = mongoose.model('User', new mongoose.Schema({
+  email: { type: String, required: true },
+  password: { type: String, required: true }
+}));
+
+const db = createMongooseAdapter({ User });
+```
+
+### 2. Initialize and Secure your Server
+```typescript
+import { createDolphinServer } from 'dolphin-server-modules/server';
+import { createAuth } from 'dolphin-server-modules/auth';
+
+const app = createDolphinServer();
+const auth = createAuth({ secret: 'SUPER_SECRET' });
+
+// Global Middleware
+app.use((ctx, next) => {
+  console.log(`🐬 ${ctx.req.method} ${ctx.req.url}`);
+  next();
+});
+
+// Hello World
+app.get('/', (ctx) => ctx.json({ message: "Welcome to Dolphin!" }));
+
+// Secure Route
+app.get('/profile', auth.middleware(), (ctx) => {
+  ctx.json({ user: ctx.req.user });
+});
+
+// Dynamic Params
+app.get('/users/:id', (ctx) => ctx.json({ id: ctx.params.id }));
+
+app.listen(3000, () => console.log("Dolphin swimming on port 3000!"));
+```
+
+---
+
 ## 🛠️ Key Features
 
 ### ⚡ 1. Native High-Performance Server (`/server`)

package/TUTORIAL.md

@@ -0,0 +1,116 @@
+# Dolphin Framework Tutorial 🐬
+
+Welcome to the official tutorial for the **Dolphin Framework**. This guide will take you from zero to a production-ready API using our native, high-performance modules.
+
+---
+
+## 1. Project Setup
+Create a new directory and initialize your project:
+```bash
+mkdir my-dolphin-app && cd my-dolphin-app
+npm init -y
+npm install dolphin-server-modules mongoose zod
+```
+
+---
+
+## 2. Database Setup (Mongoose)
+Define your models using Mongoose:
+```typescript
+// models.ts
+import mongoose from 'mongoose';
+
+const UserSchema = new mongoose.Schema({
+  email: { type: String, required: true, unique: true },
+  password: { type: String, required: true }
+});
+
+export const User = mongoose.model('User', UserSchema);
+```
+
+---
+
+## 3. Initialize Dolphin
+Create your main entry point and connect the components:
+```typescript
+// index.ts
+import { createDolphinServer } from 'dolphin-server-modules/server';
+import { createMongooseAdapter } from 'dolphin-server-modules/adapters/mongoose';
+import { createAuth } from 'dolphin-server-modules/auth';
+import { User } from './models';
+
+// 1. Setup Adapter
+const db = createMongooseAdapter({ User });
+
+// 2. Setup Auth
+const auth = createAuth({ secret: 'SUPER_SECRET' });
+
+// 3. Setup Server
+const app = createDolphinServer();
+```
+
+---
+
+## 4. Routing with Context (ctx)
+Dolphin uses a unified `ctx` object for ultra-clean handlers.
+
+```typescript
+// Simple Route
+app.get('/', (ctx) => {
+  ctx.json({ message: "Welcome to Dolphin!" });
+});
+
+// Dynamic Route with Params
+app.get('/users/:id', (ctx) => {
+  const { id } = ctx.params;
+  ctx.json({ userId: id });
+});
+
+// Post Request with Body
+app.post('/echo', (ctx) => {
+  ctx.json({ youSent: ctx.body });
+});
+```
+
+---
+
+## 5. Adding Authentication Middleware
+Secure your routes with the `auth` module:
+
+```typescript
+// Protecting a route
+app.get('/profile', auth.middleware(), (ctx) => {
+  // ctx.req.user is automatically populated
+  ctx.json({ user: ctx.req.user });
+});
+```
+
+---
+
+## 6. Global Middleware
+Add logging or custom logic to every request:
+
+```typescript
+app.use((ctx, next) => {
+  console.log(`${ctx.req.method} ${ctx.req.url}`);
+  next();
+});
+```
+
+---
+
+## 7. Starting the Server
+```typescript
+app.listen(3000, () => {
+  console.log("Dolphin is swimming on http://localhost:3000 🐬");
+});
+```
+
+---
+
+## 🚀 Performance Tips
+- Use **Context (ctx)** directly for JSON responses.
+- Keep your routes organized using prefixing (coming in v1.1.0).
+- Use the **Zod Middleware** for automatic type-safe validation.
+
+Happy Coding!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dolphin-server-modules",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Core utility modules for Auth, CRUD, and Controllers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",