Add --api Flag to Create Headless API App with create-next-app

.husky/.env.example

@@ -0,0 +1,10 @@
+# Rename this file to `.env.local` to use environment variables locally with `next dev`
+# Add .env files to your .gitignore to prevent accidentally committing sensitive information.
+# https://nextjs.org/docs/app/building-your-application/configuring/environment-variables
+MY_HOST="example.com"
+# API Configuration
+API_BASE_URL="https://api.example.com"
+API_VERSION="v1"
+# Misc
+NODE_ENV="development"
+PORT="3000"

.husky/next.config.ts

@@ -0,0 +1,7 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  /* config options here */
+};
+
+export default nextConfig;

packages/create-next-app/create-app.ts

@@ -37,6 +37,7 @@ export async function createApp({
   skipInstall,
   empty,
   turbo,
+  app-api,
 }: {
   appPath: string
   packageManager: PackageManager
@@ -51,11 +52,20 @@ export async function createApp({
   skipInstall: boolean
   empty: boolean
   turbo: boolean
+  app-api: boolean
 }): Promise<void> {
   let repoInfo: RepoInfo | undefined
   const mode: TemplateMode = typescript ? 'ts' : 'js'
-  const template: TemplateType = `${appRouter ? 'app' : 'default'}${tailwind ? '-tw' : ''}${empty ? '-empty' : ''}`
+  const template: TemplateType = app-api 
+    ? 'app-api' 
+    : `${appRouter ? 'app' : 'default'}${tailwind ? '-tw' : ''}${empty ? '-empty' : ''}`;
 
+
+  if (api && template !== 'app-api') {
+    console.error(`Invalid template for api flag: ${red(template)}`)
+    process.exit(1)
+  }
+
   if (example) {
     let repoUrl: URL | undefined
 
@@ -232,6 +242,7 @@ export async function createApp({
       importAlias,
       skipInstall,
       turbo,
+      app-api,
     })
   }
 

packages/create-next-app/index.ts

@@ -102,6 +102,12 @@ const program = new Command(packageJson.name)
     `
 
   Specify import alias to use (default "@/*").
+`
+  )
+  .option(
+    '--api',
+    `
+  Initialize a Headless API using app router.
 `
   )
   .option(
@@ -501,6 +507,7 @@ async function run(): Promise<void> {
       skipInstall: program.skipInstall,
       empty: program.empty,
       turbo: program.turbo,
+      api: program.api,
     })
   } catch (reason) {
     if (!(reason instanceof DownloadError)) {

packages/create-next-app/templates/api/js/.env.example

@@ -0,0 +1,3 @@
+# Rename this file to `.env.local` to use environment variables locally with `next dev`
+# https://nextjs.org/docs/app/building-your-application/configuring/environment-variables
+MY_HOST="example.com"

packages/create-next-app/templates/api/js/README-template.md

@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000/api](http://localhost:3000/api) with your browser to see the result.
+
+You can start editing the page by modifying `app/index.js`. The page auto-updates as you edit the file.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

packages/create-next-app/templates/api/js/api/[param]/route.js

@@ -0,0 +1,11 @@
+
+
+export async function GET(request, context) {
+    const { params } = context;
+    const { param } = params; // dynamic router
+
+    return new Response(JSON.stringify({ message: `Hello, ${param}` }), {
+      headers: { 'Content-Type': 'application/json' },
+    });
+  }
+

packages/create-next-app/templates/api/js/api/index.js

@@ -0,0 +1,3 @@
+export default (req, res) => {
+    return res.json({ message: "Hello World" });
+};

packages/create-next-app/templates/api/js/api/route.js

@@ -0,0 +1,35 @@
+export async function GET(request) {
+    return new Response(JSON.stringify({ message: "Hello World" }), {
+      headers: { 'Content-Type': 'application/json' },
+    });
+  }
+
+  export async function POST(request) {
+    const data = await request.json();
+    return new Response(JSON.stringify({ message: "Data received", data }), {
+      headers: { 'Content-Type': 'application/json' },
+    });
+  }
+
+  export async function PUT(request) {
+    const data = await request.json();
+    return new Response(JSON.stringify({ message: "Data updated", data }), {
+      headers: { 'Content-Type': 'application/json' },
+    });
+  }
+
+  export async function DELETE(request) {
+    return new Response(JSON.stringify({ message: "Data deleted" }), {
+      headers: { 'Content-Type': 'application/json' },
+    });
+  }
+
+  export async function OPTIONS() {
+    return new Response(null, {
+      headers: {
+        'Allow': 'GET, POST, PUT, DELETE, OPTIONS',
+        'Content-Length': '0',
+      },
+    });
+  }
+

packages/create-next-app/templates/api/js/eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

packages/create-next-app/templates/api/js/gitignore

@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# env files (can opt-in for commiting if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

packages/create-next-app/templates/api/js/jsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./*"]
+    }
+  }
+}

packages/create-next-app/templates/api/js/next.config.mjs

@@ -0,0 +1,16 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+    // API routes configuration
+  api: {
+
+    bodyParser: {
+      sizeLimit: '1mb',
+    },
+    cors: {
+      origin: '*',
+      methods: ['GET', 'POST', 'PUT', 'DELETE'],
+    },
+  },
+};
+
+export default nextConfig;

packages/create-next-app/templates/api/ts/.env.example

@@ -0,0 +1,4 @@
+# Rename this file to `.env.local` to use environment variables locally with `next dev`
+# Add .env files to your .gitignore to prevent accidentally committing sensitive information.
+# https://nextjs.org/docs/app/building-your-application/configuring/environment-variables
+MY_HOST="example.com"

packages/create-next-app/templates/api/ts/README-template.md

@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000/api](http://localhost:3000/api) with your browser to see the result.
+
+You can start editing the page by modifying `app/index.ts`. The page auto-updates as you edit the file.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

packages/create-next-app/templates/api/ts/api/index.ts

@@ -0,0 +1,5 @@
+import { VercelRequest, VercelResponse } from "@vercel/node";
+
+export default (req: VercelRequest, res: VercelResponse) => {
+  return res.json({ message: "Hello World" });
+};

packages/create-next-app/templates/api/ts/api/route.ts

@@ -0,0 +1,36 @@
+import { NextRequest, NextResponse } from 'next/server';
+
+export async function GET(request: NextRequest) {
+  return NextResponse.json({ message: "Hello World" }, {
+    headers: { 'Content-Type': 'application/json' },
+  });
+}
+
+export async function POST(request: NextRequest) {
+  const data = await request.json();
+  return NextResponse.json({ message: "Data received", data }, {
+    headers: { 'Content-Type': 'application/json' },
+  });
+}
+
+export async function PUT(request: NextRequest) {
+  const data = await request.json();
+  return NextResponse.json({ message: "Data updated", data }, {
+    headers: { 'Content-Type': 'application/json' },
+  });
+}
+
+export async function DELETE(request: NextRequest) {
+  return NextResponse.json({ message: "Data deleted" }, {
+    headers: { 'Content-Type': 'application/json' },
+  });
+}
+
+export async function OPTIONS(request: NextRequest) {
+  return new Response(null, {
+    headers: {
+      'Allow': 'GET, POST, PUT, DELETE, OPTIONS',
+      'Content-Length': '0',
+    },
+  });
+}

packages/create-next-app/templates/api/ts/eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["next/core-web-vitals", "next/typescript"]
+}

packages/create-next-app/templates/api/ts/gitignore

@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# env files (can opt-in for commiting if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

packages/create-next-app/templates/api/ts/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

packages/create-next-app/templates/api/ts/next.config.ts

@@ -0,0 +1,17 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  /* config options here */
+  // API routes configuration
+  api: {
+    bodyParser: {
+      sizeLimit: '1mb',
+    },
+    cors: {
+      origin: '*',
+      methods: ['GET', 'POST', 'PUT', 'DELETE'],
+    },
+  },
+};
+
+export default nextConfig;