create-audora-next 0.1.7 → 2.0.1

package/README.md

@@ -2,13 +2,23 @@
 
 Create a new Audora Next.js app with one command.
 
+## Preview
+
+**Base template**
+
+![Audora Next](./assets/audora-next.webp)
+
+**Blog template**
+
+![Audora Blog](./assets/audora-blog.png)
+
 ## Quick Start
 
 ```bash
 bunx create-audora-next my-app
 ```
 
-Then follow the prompts, or use:
+Use `--blog` to create the blog template. Then follow the prompts, or use:
 
 ```bash
 cd my-app
@@ -20,10 +30,10 @@ Open [http://localhost:3000](http://localhost:3000) to see your app.
 
 ## Available Templates
 
-| Template | Status      |
-| -------- | ----------- |
-| `base`   | Available   |
-| `blog`   | Coming Soon |
+| Template | Status    | Usage                                   |
+| -------- | --------- | --------------------------------------- |
+| `base`   | Available | `bunx create-audora-next my-app`        |
+| `blog`   | Available | `bunx create-audora-next my-app --blog` |
 
 ## Base Template Features
 
@@ -45,6 +55,16 @@ Open [http://localhost:3000](http://localhost:3000) to see your app.
 - Husky & lint-staged
 - Path alias (`@/*`)
 
+## Blog Template
+
+The blog template includes everything in the base template, plus:
+
+- MDX-based blog posts with frontmatter
+- Blog index at `/blogs` and post pages at `/blogs/[slug]`
+- Content in `src/blogs/content` (MDX files)
+- Blog components (post cards, table of contents, etc.)
+- Ready for adding pagination and search
+
 ## Requirements
 
 - [Bun](https://bun.sh) v1.0.0 or higher

package/index.ts

@@ -6,7 +6,9 @@ import { execSync } from "child_process";
 import pc from "picocolors";
 import ora from "ora";
 
-const projectName = process.argv[2];
+const args = process.argv.slice(2);
+const useBlogTemplate = args.includes("-blog") || args.includes("--blog");
+const projectName = args.find((arg) => arg !== "-blog" && arg !== "--blog");
 
 // Validate project name
 if (!projectName) {
@@ -14,7 +16,7 @@ if (!projectName) {
   console.log(
     `\nUsage: ${pc.cyan("bunx create-audora-next")} ${pc.green(
       "<project-name>"
-    )}\n`
+    )} ${pc.dim("[--blog]")}\n`
   );
   process.exit(1);
 }
@@ -37,13 +39,16 @@ if (existsSync(targetDir)) {
   process.exit(1);
 }
 
+const templateDir = useBlogTemplate ? "blog" : "base";
 console.log(
-  `\nCreating a new ${pc.bold("Audora Next")} app in ${pc.cyan(targetDir)}...\n`
+  `\nCreating a new ${pc.bold("Audora Next")} app${
+    useBlogTemplate ? ` ${pc.dim("(blog template)")}` : ""
+  } in ${pc.cyan(targetDir)}...\n`
 );
 
 // Copy template
 mkdirSync(targetDir);
-cpSync(new URL("./templates/base", import.meta.url), targetDir, {
+cpSync(new URL(`./templates/${templateDir}`, import.meta.url), targetDir, {
   recursive: true,
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-audora-next",
-  "version": "0.1.7",
+  "version": "2.0.1",
   "description": "Create a new Audora Next.js app with one command",
   "keywords": [
     "create",
@@ -14,12 +14,18 @@
   "type": "module",
   "license": "MIT",
   "private": false,
+  "scripts": {
+    "test:local": "bash scripts/test-local.sh",
+    "clean": "rm -rf node_modules .next .turbo",
+    "publish:local": "bun run index.ts --blog"
+  },
   "bin": {
     "create-audora-next": "./index.ts"
   },
   "files": [
     "index.ts",
-    "templates"
+    "templates",
+    "assets"
   ],
   "devDependencies": {
     "@types/bun": "latest"

package/templates/blog/README.md

@@ -0,0 +1,164 @@
+# next-starter
+
+This project uses [create-audora-next](https://www.npmjs.com/package/create-audora-next) as its base.
+
+## Quick Start
+
+```bash
+bunx degit audoralabs/next-starter my-app
+cd my-app
+git init
+bun install
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see your app.
+
+## Planned Features
+
+- **MDX loading** - Author posts with MDX and frontmatter support.
+- **Pagination** - First-class paginated lists for posts and tags.
+- **Search** - Fast, client-side search across content.
+
+### Recommended Packages
+
+- **MDX** - `@next/mdx` and `contentlayer`
+- **Search** - `flexsearch`
+- **Pagination** - Custom paginator (no external package)
+
+## What's Included
+
+### Core Stack
+
+| Technology   | Version | Notes                          |
+| ------------ | ------- | ------------------------------ |
+| Next.js      | 16.1.1  | App Router, Turbopack enabled  |
+| React        | 19.2.3  | React Compiler enabled         |
+| TypeScript   | 5       | Strict mode                    |
+| Tailwind CSS | 4       | PostCSS, no config file needed |
+| Bun          | Latest  | Package manager and runtime    |
+
+### SEO
+
+This starter ships with everything you need for search engine optimization:
+
+- **Open Graph & Twitter Cards** - Complete social sharing metadata
+- **Structured Data (JSON-LD)** - WebSite, Organization, and Breadcrumb schemas
+- **Dynamic robots.txt** - Generated from `robots.ts`
+- **Dynamic sitemap.xml** - Generated from `sitemap.ts`
+- **llms.txt** - AI-friendly documentation for LLM assistants
+- **Title Templates** - Consistent page titles with `%s - Site Name` pattern
+- **Canonical URLs** - Prevent duplicate content issues
+- **PWA Manifest** - Web app manifest with icons and screenshots
+
+### Security
+
+Pre-configured security headers in `next.config.ts`:
+
+- `X-Content-Type-Options: nosniff`
+- `X-Frame-Options: DENY`
+- `X-XSS-Protection: 1; mode=block`
+- `Referrer-Policy: strict-origin-when-cross-origin`
+- `Permissions-Policy` - Camera, microphone, geolocation disabled
+
+### Developer Experience
+
+- **ESLint 9** - Flat config with Next.js rules
+- **Prettier** - With Tailwind CSS plugin for class sorting
+- **Husky** - Git hooks for pre-commit linting
+- **lint-staged** - Run linters on staged files only
+- **Path Alias** - `@/*` mapped to `./src/*`
+
+> **Note:** Git hooks (Husky) are installed automatically when a Git repository is present.
+> If you initialize Git after installing dependencies, re-run `bun install` to enable hooks.
+
+- **Type Checking** - Dedicated `check-types` script
+
+### UI
+
+- **Dark Mode** - System preference detection with next-themes
+- **Geist Font** - Pre-configured sans and mono variants
+- **cn() Utility** - Combines clsx and tailwind-merge
+
+## Project Structure
+
+```
+src/
+├── app/
+│   ├── layout.tsx          # Root layout with metadata and JSON-LD
+│   ├── page.tsx            # Home page
+│   ├── manifest.ts         # PWA web app manifest
+│   ├── robots.ts           # robots.txt generation
+│   ├── sitemap.ts          # sitemap.xml generation
+│   ├── llms.txt/           # AI-friendly summary
+│   └── llms-full.txt/      # AI-friendly full documentation
+├── components/
+│   ├── icons.tsx           # Icon components
+│   ├── theme-provider.tsx  # Theme context provider
+│   └── theme-toggle.tsx    # Dark/light mode toggle
+├── config/
+│   └── site.ts             # Site configuration exports
+├── data/
+│   ├── site.ts             # Site metadata (name, URL, description)
+│   └── llms.ts             # llms.txt content configuration
+├── lib/
+│   └── seo.ts              # SEO utilities and JSON-LD generators
+├── styles/
+│   └── globals.css         # Global styles and Tailwind imports
+└── utils/
+    └── cn.ts               # Class name merge utility
+```
+
+## Configuration
+
+### Site Metadata
+
+Edit `src/data/site.ts` to customize your site:
+
+```typescript
+const SITE_DATA = {
+  name: "my-app",
+  url: "https://my-app.com",
+  ogImage: "https://my-app.com/og.png",
+  tagline: "Your tagline here",
+  description: "Your full description",
+  twitterHandle: "@myapp",
+  keywords: ["keyword1", "keyword2"],
+};
+```
+
+### LLMs.txt Content
+
+Edit `src/data/llms.ts` to customize AI-friendly documentation.
+
+## Scripts
+
+| Command                | Description                      |
+| ---------------------- | -------------------------------- |
+| `bun dev`              | Start dev server with Turbopack  |
+| `bun run build`        | Build for production             |
+| `bun start`            | Start production server          |
+| `bun lint`             | Run ESLint                       |
+| `bun lint:fix`         | Run ESLint with auto-fix         |
+| `bun check-types`      | Run TypeScript type checking     |
+| `bun format`           | Format all files with Prettier   |
+| `bun format:check`     | Check formatting without writing |
+| `bun clean`            | Remove .next and node_modules    |
+| `bun upgrade:next`     | Upgrade Next.js to latest        |
+| `bun upgrade:tailwind` | Upgrade Tailwind CSS             |
+
+## Why These Choices
+
+**Bun** - Faster installs, native TypeScript, smaller lockfile.
+
+**App Router** - Server components, streaming, better layouts. Pages Router is legacy.
+
+**React Compiler** - Automatic memoization without manual `useMemo`/`useCallback`.
+
+**Tailwind CSS 4** - Native CSS layers, `@theme` directive, no config file for basics.
+
+**ESLint Flat Config** - Cleaner, more composable than `.eslintrc` files.
+
+**No Component Library** - Start clean, add shadcn/ui or Radix when needed.
+
+**Turbopack** - Faster dev server and builds.