create-colonel 0.1.4 → 0.1.6

package/README.md

@@ -2,6 +2,11 @@
 
 Scaffold a new Colonel app from the command line.
 
+[![npm version](https://img.shields.io/npm/v/create-colonel)](https://www.npmjs.com/package/create-colonel)
+[![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](../../LICENSE)
+[![Runtime: Bun](https://img.shields.io/badge/runtime-bun-black)](https://bun.sh)
+[![Template](https://img.shields.io/badge/template-included-2F6FED)](template)
+
 ## Usage
 
 ```bash
@@ -45,6 +50,18 @@ bun packages/create-colonel/src/cli.ts my-app
 
 When run inside this repository, the CLI auto-links the local framework package for easier development.
 
+## Tests
+
+There are no dedicated automated tests for this package yet.
+
+Recommended smoke test from repository root:
+
+```bash
+rm -rf /tmp/colonel-smoke && bun packages/create-colonel/src/cli.ts /tmp/colonel-smoke
+cd /tmp/colonel-smoke
+bun run start
+```
+
 ## Publishing
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-colonel",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "type": "module",
   "files": [
     "src",

package/template/README.md

@@ -1,6 +1,10 @@
-# Colonel App
+# Colonel App Template
 
-Generated with `create-colonel`.
+[![Scaffolded by](https://img.shields.io/badge/scaffold-create--colonel-2F6FED)](../README.md)
+[![Runtime: Bun](https://img.shields.io/badge/runtime-bun-black)](https://bun.sh)
+[![Framework](https://img.shields.io/badge/framework-@coloneldev%2Fframework-0A7B34)](https://www.npmjs.com/package/@coloneldev/framework)
+
+This template is copied into new projects created by `create-colonel`.
 
 ## Run
 
@@ -10,3 +14,20 @@ bun run start
 ```
 
 Server runs at http://localhost:5000.
+
+## Upgrade Colonel
+
+Upgrade your app to the latest published framework:
+
+```bash
+bun run upgrade:colonel
+```
+
+## Tests
+
+This template itself does not include app-specific automated tests yet.
+Framework integration tests can be run from the monorepo root where Colonel source is developed:
+
+```bash
+bun run test
+```

package/template/package.json

@@ -1,13 +1,14 @@
 {
   "name": "colonel-app",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "type": "module",
   "private": true,
   "scripts": {
-    "start": "bun --watch src/index.ts"
+    "start": "bun --watch src/index.ts",
+    "upgrade:colonel": "bun add @coloneldev/framework@latest"
   },
   "dependencies": {
-    "@coloneldev/framework": "^0.1.2",
+    "@coloneldev/framework": "^0.1.5",
     "ejs": "^5.0.1"
   },
   "devDependencies": {

package/template/resources/views/base/index.ejs

@@ -1 +1,157 @@
-<h1>Welcome to Colonel</h1>
+<section class="landing-shell">
+	<style>
+		@import url('https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@400;600;700&family=IBM+Plex+Mono:wght@400;500&display=swap');
+
+		:root {
+			--ink: #0d1310;
+			--ink-soft: #203329;
+			--canvas: #f3f1e9;
+			--accent: #b8441a;
+			--accent-soft: #db7c31;
+			--panel: #ffffff;
+			--olive: #5e6a39;
+			--line: #d8d3c7;
+		}
+
+		body {
+			margin: 0;
+			background: radial-gradient(circle at 80% 10%, #f8e6c7 0%, var(--canvas) 38%, #ede8da 100%);
+			color: var(--ink);
+			font-family: 'Space Grotesk', sans-serif;
+		}
+
+		.landing-shell {
+			max-width: 1040px;
+			margin: 0 auto;
+			padding: 2rem 1rem 3rem;
+		}
+
+		.hero {
+			border: 1px solid var(--line);
+			background: linear-gradient(125deg, #fffdf8 0%, #f6f3e9 100%);
+			border-radius: 22px;
+			padding: 2.2rem;
+			box-shadow: 0 16px 45px rgba(32, 51, 41, 0.09);
+			animation: rise 0.65s ease;
+		}
+
+		.kicker {
+			font-family: 'IBM Plex Mono', monospace;
+			letter-spacing: 0.1em;
+			font-size: 0.74rem;
+			color: var(--olive);
+			margin-bottom: 1rem;
+		}
+
+		h1 {
+			font-size: clamp(2rem, 5vw, 3.8rem);
+			line-height: 1.03;
+			margin: 0;
+			max-width: 16ch;
+		}
+
+		.lead {
+			margin-top: 1rem;
+			font-size: 1.04rem;
+			color: var(--ink-soft);
+			max-width: 65ch;
+		}
+
+		.cta {
+			display: flex;
+			gap: 0.75rem;
+			flex-wrap: wrap;
+			margin-top: 1.4rem;
+		}
+
+		.btn {
+			text-decoration: none;
+			padding: 0.72rem 1.05rem;
+			border-radius: 999px;
+			font-weight: 600;
+			border: 1px solid transparent;
+		}
+
+		.btn-primary {
+			background: var(--accent);
+			color: #fff;
+		}
+
+		.btn-secondary {
+			border-color: var(--line);
+			color: var(--ink);
+			background: #fff;
+		}
+
+		.grid {
+			margin-top: 1.25rem;
+			display: grid;
+			grid-template-columns: repeat(3, minmax(0, 1fr));
+			gap: 0.8rem;
+		}
+
+		.tile {
+			background: var(--panel);
+			border: 1px solid var(--line);
+			border-radius: 14px;
+			padding: 0.95rem;
+		}
+
+		.tile strong {
+			display: block;
+			margin-bottom: 0.35rem;
+		}
+
+		.tile p {
+			margin: 0;
+			color: var(--ink-soft);
+			font-size: 0.94rem;
+		}
+
+		.meta {
+			margin-top: 1rem;
+			font-family: 'IBM Plex Mono', monospace;
+			font-size: 0.78rem;
+			color: #4f5e54;
+		}
+
+		@keyframes rise {
+			from { opacity: 0; transform: translateY(12px); }
+			to { opacity: 1; transform: translateY(0); }
+		}
+
+		@media (max-width: 840px) {
+			.hero { padding: 1.35rem; }
+			.grid { grid-template-columns: 1fr; }
+		}
+	</style>
+
+	<article class="hero">
+		<div class="kicker">COLONEL // APP TEMPLATE</div>
+		<h1>Your first Colonel app starts with opinionated clarity.</h1>
+		<p class="lead">
+			This starter includes route wiring, controller injection, static file handling, and view composition so you can focus on real application behavior from day one.
+		</p>
+		<div class="cta">
+			<a class="btn btn-primary" href="/users">View User Route</a>
+			<a class="btn btn-secondary" href="<%= docsUrl || 'https://gwhitdev.github.io/colonel-framework/' %>" target="_blank" rel="noreferrer">Open Documentation</a>
+		</div>
+
+		<div class="grid">
+			<div class="tile">
+				<strong>Practical Defaults</strong>
+				<p>Project structure and startup wiring are ready for immediate feature work.</p>
+			</div>
+			<div class="tile">
+				<strong>Dependency Injection</strong>
+				<p>Controllers receive services explicitly via static inject tokens.</p>
+			</div>
+			<div class="tile">
+				<strong>Upgrade Path</strong>
+				<p>Use <code>bun run upgrade:colonel</code> to pull the latest framework release.</p>
+			</div>
+		</div>
+
+		<div class="meta">GENERATED WITH create-colonel • Runtime: Bun • Language: TypeScript</div>
+	</article>
+</section>

package/template/src/app/Http/Controllers/AppController.ts

@@ -1,16 +1,25 @@
+import type { HttpRequest } from "@coloneldev/framework";
 import Controller from './Controller';
+import { AppInfoService } from '../../Services/AppInfoService';
 
 export class AppController extends Controller {
-    constructor() {
+    static inject = [AppInfoService];
+
+    constructor(private appInfoService: AppInfoService) {
         super();
     }
 
-    index(): Record<string, any> {
+    index(req: HttpRequest): Record<string, any> {
+        const previousVisits = this.sessionGet<number>(req, "visits") ?? 0;
+        const visits = previousVisits + 1;
+        this.sessionPut(req, "visits", visits);
+
         return [
             'base/index',
             {
-                "titleData": "Welcome",
-                
+                "titleData": this.appInfoService.welcomeTitle(),
+                "docsUrl": this.appInfoService.documentationUrl(),
+                "footerData": `Session visits: ${visits}`,
             },
         ]
     }

package/template/src/app/Http/Controllers/Controller.ts

@@ -1,3 +1,5 @@
+import type { HttpRequest, Session } from "@coloneldev/framework";
+
 export default class Controller {
     constructor() {
         // Base constructor logic can be added here if needed
@@ -6,4 +8,24 @@ export default class Controller {
     health(): Record<string, string> {
         return { status: "ok" };
     }
+
+    protected requireSession(req: HttpRequest): Session {
+        if (!req.session) {
+            throw new Error("Session is not enabled for this request");
+        }
+
+        return req.session;
+    }
+
+    protected sessionGet<T = unknown>(req: HttpRequest, key: string): T | undefined {
+        return this.requireSession(req).get<T>(key);
+    }
+
+    protected sessionPut(req: HttpRequest, key: string, value: unknown): void {
+        this.requireSession(req).set(key, value);
+    }
+
+    protected sessionForget(req: HttpRequest, key: string): void {
+        this.requireSession(req).forget(key);
+    }
 }

package/template/src/app/Services/AppInfoService.ts

@@ -1,7 +1,14 @@
 export class AppInfoService {
-    constructor(private appName: string) {}
+    constructor(
+        private appName: string,
+        private docsUrl: string = "https://gwhitdev.github.io/colonel-framework/"
+    ) {}
 
     welcomeTitle(): string {
         return `Welcome to ${this.appName}`;
     }
+
+    documentationUrl(): string {
+        return this.docsUrl;
+    }
 }

package/template/src/bootstrap/server.ts

@@ -13,11 +13,20 @@ const publicRoot = path.resolve(import.meta.dir, "..", "..", "public");
 const controllerRoot = path.resolve(import.meta.dir, "..", "app", "Http", "Controllers");
 const container = new Container();
 
-container.singleton(AppInfoService, () => new AppInfoService(process.env.appName ?? "Colonel"));
+container.singleton(
+    AppInfoService,
+    () => new AppInfoService(
+        process.env.appName ?? "Colonel",
+        process.env.COLONEL_DOCS_URL ?? "https://gwhitdev.github.io/colonel-framework/"
+    )
+);
 
 export const server = () => {
     const Colonel = new Kernel(webRouter, [], {
         viewsRoot,
+        session: {
+            enabled: true,
+        },
         controllerResolver: async (name: string) => {
             const modulePath = `${controllerRoot}/${name}.ts`;
             const mod = await import(modulePath);