Initial commit from Create Next App

techlahoma · Apr 20, 2023 · f136af0 · f136af0
commit f136af0
Show file tree

Hide file tree

Showing 9 changed files with 836 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,38 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+# The `out` directory should not be ignored by version control
+# /out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+.vscode
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# Deploying to GitHub Pages
+
+This example supports deloying a statically exported Next.js application to GitHub Pages.
+
+The `out` directory should not be ignored by version control.
+
+## How to use
+
+Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
+
+```bash
+npx create-next-app --example github-pages nextjs-github-pages
+# or
+yarn create next-app --example github-pages nextjs-github-pages
+# or
+pnpm create next-app --example github-pages nextjs-github-pages
+```
+
+### Deploy to GitHub Pages
+
+1.  Create a new public GitHub repository.
+1.  Edit `next.config.js` to match your GitHub repository name.
+1.  Push the starter code to the `main` branch.
+1.  Run the `deploy` script (e.g. `npm run deploy`) to create the `gh-pages` branch.
+1.  On GitHub, go to **Settings** > **Pages** > **Branch**, and choose `gh-pages` as the branch with the `/root` folder. Hit **Save**.
+1.  Make a change.
+1.  Run the `deploy` script again to push the changes to GitHub Pages.
+
+Congratulations! You should have a URL like:
+
+```bash
+https://<github-user-name>.github.io/<github-project-name>/
+```
diff --git a/app/about/page.tsx b/app/about/page.tsx
@@ -0,0 +1,12 @@
+import Link from 'next/link'
+
+export default function About() {
+  return (
+    <>
+      <h1>About</h1>
+      <div>
+        Back to <Link href="/">Home</Link>
+      </div>
+    </>
+  )
+}
diff --git a/app/layout.tsx b/app/layout.tsx
@@ -0,0 +1,11 @@
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode
+}) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/app/page.tsx b/app/page.tsx
@@ -0,0 +1,9 @@
+import Link from 'next/link'
+
+export default function Home() {
+  return (
+    <div>
+      Hello World. <Link href="/about">About</Link>
+    </div>
+  )
+}
diff --git a/next.config.js b/next.config.js
@@ -0,0 +1,14 @@
+// @ts-check
+
+/**
+ * @type {import('next').NextConfig}
+ **/
+const nextConfig = {
+  output: 'export',
+  basePath: '/gh-pages-test',
+  experimental: {
+    appDir: true,
+  },
+}
+
+module.exports = nextConfig