canx-starter-api 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# Canx Starter API
+
+⚡ Minimal REST API template for CanxJS with JWT authentication.
+
+## Features
+
+- ✅ **JWT Authentication** - Token-based auth with refresh tokens
+- ✅ **API Routes** - Clean REST API structure
+- ✅ **Validation** - Request validation with built-in validators
+- ✅ **Error Handling** - Consistent JSON error responses
+
+## Quick Start
+
+```bash
+# Clone or copy this starter
+bunx degit chandafa/canx-starters/api my-api
+
+# Install dependencies
+cd my-api
+bun install
+
+# Start development server
+bun run dev
+```
+
+## Project Structure
+
+```
+src/
+├── controllers/     # API controllers
+│   ├── AuthController.ts
+│   └── UserController.ts
+├── middlewares/     # Custom middleware
+│   └── auth.ts
+├── routes.ts        # API route definitions
+└── app.ts           # Application entry
+```
+
+## API Endpoints
+
+| Method | Endpoint             | Description                |
+| ------ | -------------------- | -------------------------- |
+| POST   | `/api/auth/register` | Register new user          |
+| POST   | `/api/auth/login`    | Login and get token        |
+| POST   | `/api/auth/refresh`  | Refresh access token       |
+| GET    | `/api/users`         | List all users (protected) |
+| GET    | `/api/users/:id`     | Get user by ID (protected) |
+
+## Available Scripts
+
+| Command         | Description                              |
+| --------------- | ---------------------------------------- |
+| `bun run dev`   | Start development server with hot reload |
+| `bun run build` | Build for production                     |
+| `bun run start` | Run production build                     |
+
+## Configuration
+
+Create a `.env` file:
+
+```env
+PORT=3000
+JWT_SECRET=your-jwt-secret
+JWT_EXPIRES_IN=7d
+```
+
+## Learn More
+
+- [CanxJS Documentation](https://docs-canxjs.netlify.app)
+- [API Reference](https://docs-canxjs.netlify.app/docs/api)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "canx-starter-api",
+  "version": "1.0.0",
+  "description": "Minimal API Starter Kit for CanxJS - REST API with JWT Authentication",
+  "author": "CanxJS Team",
+  "license": "MIT",
+  "keywords": [
+    "canxjs",
+    "starter",
+    "template",
+    "api",
+    "rest",
+    "bun",
+    "jwt"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chandafa/canx-starters.git",
+    "directory": "api"
+  },
+  "scripts": {
+    "dev": "bun --watch src/app.ts",
+    "build": "bun build src/app.ts --outdir dist",
+    "start": "bun run dist/app.js"
+  },
+  "dependencies": {
+    "canxjs": "^1.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "bun-types": "latest",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  }
+}

package/src/app.ts

@@ -0,0 +1,15 @@
+import { Canx } from "canxjs";
+import { routes } from "./routes";
+
+const app = new Canx();
+
+// Register routes
+app.routes(routes);
+
+// Start the server
+app.start({
+  port: 3001,
+  development: true,
+});
+
+console.log("Canx API Starter running on http://localhost:3001");

package/src/controllers/AuthController.ts

@@ -0,0 +1,33 @@
+import { BaseController, Request, Response } from "canxjs";
+
+export class AuthController extends BaseController {
+  
+  public async login() {
+    const { email, password } = await this.body<{email: string, password: string}>();
+    
+    // Mock authentication logic
+    if (email === "test@example.com" && password === "password") {
+       return this.json({
+         token: "mock-jwt-token-123456",
+         user: {
+           id: 1,
+           name: "Test User",
+           email: "test@example.com"
+         }
+       });
+    }
+
+    return this.json({ message: "Invalid credentials" }, 401);
+  }
+
+  public async register() {
+     const { name, email, password } = await this.body<{name: string, email: string, password: string}>();
+     
+     // Mock registration
+     return this.json({
+       message: "User registered successfully",
+       user: { id: 2, name, email },
+       token: "mock-jwt-token-new-user"
+     }, 201);
+  }
+}

package/src/controllers/UserController.ts

@@ -0,0 +1,13 @@
+import { BaseController, Request, Response } from "canxjs";
+
+export class UserController extends BaseController {
+  
+  public async me() {
+    // In real app, user is attached to request by auth middleware
+    return this.json({
+      id: 1,
+      name: "Test User",
+      email: "test@example.com"
+    });
+  }
+}

package/src/routes.ts

@@ -0,0 +1,13 @@
+import { Router } from "canxjs";
+import { AuthController } from "./controllers/AuthController";
+import { UserController } from "./controllers/UserController";
+
+export const routes = (router: Router) => {
+  // API Routes
+  router.post("/api/login", [AuthController, "login"]);
+  router.post("/api/register", [AuthController, "register"]);
+  
+  // Protected Routes
+  // middleware: ['auth:api']
+  router.get("/api/user", [UserController, "me"]);
+};

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "types": ["bun-types"],
+    "strict": true,
+    "skipLibCheck": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}