@keystatic/templates-nextjs 0.0.0-test-20230817012139

package/CHANGELOG.md

@@ -0,0 +1,116 @@
+# @keystatic/templates-nextjs
+
+## 0.0.0-test-20230817012139
+
+### Patch Changes
+
+- Updated dependencies [6895c566]
+- Updated dependencies [ca6774b8]
+  - @keystatic/core@0.0.0-test-20230817012139
+
+## 0.0.13
+
+### Patch Changes
+
+- Updated dependencies [c43d7045]
+- Updated dependencies [21395048]
+  - @keystatic/core@0.0.116
+
+## 0.0.12
+
+### Patch Changes
+
+- Updated dependencies [ad46c9dd]
+- Updated dependencies [47102969]
+  - @keystatic/core@0.0.115
+
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies [6b4c476c]
+- Updated dependencies [f9f09616]
+  - @keystatic/core@0.0.114
+
+## 0.0.10
+
+### Patch Changes
+
+- Updated dependencies [07c63bab]
+- Updated dependencies [062ccf49]
+  - @keystatic/core@0.0.113
+
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies [efc83c9c]
+  - @keystatic/core@0.0.112
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies [bf6a27bb]
+  - @keystatic/core@0.0.111
+
+## 0.0.7
+
+### Patch Changes
+
+- Updated dependencies [e667fb9c]
+- Updated dependencies [aec6359b]
+- Updated dependencies [e0c4c37e]
+- Updated dependencies [781884f9]
+- Updated dependencies [cafe3695]
+  - @keystatic/core@0.0.110
+
+## 0.0.6
+
+### Patch Changes
+
+- Updated dependencies [4e595627]
+- Updated dependencies [477b4e96]
+- Updated dependencies [b832e495]
+- Updated dependencies [b6f4fb12]
+- Updated dependencies [68e3be7c]
+  - @keystatic/core@0.0.109
+
+## 0.0.5
+
+### Patch Changes
+
+- Updated dependencies [bbbca74f]
+- Updated dependencies [944dbe67]
+- Updated dependencies [91857b9b]
+- Updated dependencies [0bafd9f1]
+- Updated dependencies [9f16e062]
+  - @keystatic/core@0.0.108
+
+## 0.0.4
+
+### Patch Changes
+
+- 12905059: Moved API routes from pages to app directory.
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies [0327f443]
+  - @keystatic/next@0.0.11
+
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies [0016a2b0]
+- Updated dependencies [cd2d22d7]
+  - @keystatic/core@0.0.107
+  - @keystatic/next@0.0.10
+
+## 0.0.1
+
+### Patch Changes
+
+- 818a4c14: Initial release of the NextJS template package.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Thinkmill Labs Pty Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+# Keystatic in Next.js
+
+This template shows how you can use Keystatic in a Next.js site that utilises
+the `app` directory.
+
+To setup:
+
+```bash
+npm install
+```
+
+To run:
+
+```
+npm run dev
+```
+
+Admin UI: [http://127.0.0.1:3000/keystatic](http://127.0.0.1:3000/keystatic)
+
+Homepage: [http://localhost:3000](http://localhost:3000)

package/app/[slug]/layout.tsx

@@ -0,0 +1,9 @@
+import '../styles.css';
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return <>{children}</>;
+}

package/app/[slug]/page.tsx

@@ -0,0 +1,27 @@
+import { DocumentRenderer } from '@keystatic/core/renderer';
+import { reader } from '../reader';
+
+export default async function Post({ params }: { params: { slug: string } }) {
+  const { slug } = params;
+
+  const post = await reader.collections.posts.read(slug);
+
+  if (!post) return <div>Post not found!</div>;
+
+  return (
+    <div>
+      <h1>{post.title}</h1>
+      <div>
+        <DocumentRenderer document={await post.content()} />
+      </div>
+    </div>
+  );
+}
+
+export async function generateStaticParams() {
+  const slugs = await reader.collections.posts.list();
+
+  return slugs.map(slug => ({
+    slug,
+  }));
+}

package/app/api/keystatic/[...params]/route.ts

@@ -0,0 +1,6 @@
+import { makeRouteHandler } from '@keystatic/next/route-handler';
+import keystaticConfig from '../../../../keystatic.config';
+
+export const { POST, GET } = makeRouteHandler({
+  config: keystaticConfig,
+});

package/app/keystatic/[[...params]]/page.tsx

@@ -0,0 +1,3 @@
+export default function Page() {
+  return null;
+}

package/app/keystatic/keystatic.tsx

@@ -0,0 +1,6 @@
+'use client';
+
+import { makePage } from '@keystatic/next/ui/app';
+import config from '../../keystatic.config';
+
+export default makePage(config);

package/app/keystatic/layout.tsx

@@ -0,0 +1,5 @@
+import KeystaticApp from './keystatic';
+
+export default function RootLayout() {
+  return <KeystaticApp />;
+}

package/app/layout.tsx

@@ -0,0 +1,11 @@
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  );
+}

package/app/page.tsx

@@ -0,0 +1,26 @@
+import Link from 'next/link';
+import { reader } from './reader';
+import './styles.css';
+
+export default async function Homepage() {
+  const posts = await reader.collections.posts.all();
+
+  return (
+    <div>
+      <h1>Keystatic ⚡️</h1>
+      <p>This homepage shows how to load a collection from the reader API.</p>
+      <p>
+        <a href="/keystatic">Click here to visit the Admin UI</a>, or the link
+        below to view a post in the collection.
+      </p>
+      <h2>Posts</h2>
+      <ul>
+        {posts.map(post => (
+          <li key={post.slug}>
+            <Link href={`/${post.slug}`}>{post.entry.title}</Link>
+          </li>
+        ))}
+      </ul>
+    </div>
+  );
+}

package/app/reader.ts

@@ -0,0 +1,4 @@
+import { createReader } from '@keystatic/core/reader';
+import keystaticConfig from '../keystatic.config';
+
+export const reader = createReader(process.cwd(), keystaticConfig);

package/app/styles.css

@@ -0,0 +1,24 @@
+html {
+  max-width: 70ch;
+  padding: 3rem 1rem;
+  margin: auto;
+  line-height: 1.75;
+  font-size: 1.25rem;
+  font-family: sans-serif;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  margin: 1rem 0 1rem;
+}
+
+p,
+ul,
+ol {
+  margin-bottom: 1rem;
+  color: #1d1d1d;
+}

package/keystatic.config.ts

@@ -0,0 +1,25 @@
+import { config, collection, fields } from '@keystatic/core';
+
+export default config({
+  storage: {
+    kind: 'local',
+  },
+  collections: {
+    posts: collection({
+      label: 'Posts',
+      slugField: 'title',
+      path: 'posts/*',
+      format: { contentField: 'content' },
+      schema: {
+        title: fields.slug({ name: { label: 'Title' } }),
+        content: fields.document({
+          label: 'Content',
+          formatting: true,
+          dividers: true,
+          links: true,
+          images: true,
+        }),
+      },
+    }),
+  },
+});

package/next.config.js

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+module.exports = {
+  reactStrictMode: false,
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@keystatic/templates-nextjs",
+  "version": "0.0.0-test-20230817012139",
+  "license": "MIT",
+  "dependencies": {
+    "@keystatic/core": "0.0.0-test-20230817012139",
+    "@keystatic/next": "^0.0.11",
+    "next": "^13.4.8",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.8",
+    "typescript": "^5.1.3"
+  },
+  "scripts": {
+    "build": "next build",
+    "dev": "next dev",
+    "start": "next start"
+  }
+}

package/posts/first-post.mdoc

@@ -0,0 +1,6 @@
+---
+title: First post
+---
+First!
+
+You can edit this page in the [Admin UI](/keystatic/collection/posts/item/first-post), or directly in your IDE at `./posts/first-post.mdoc`.

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "incremental": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "downlevelIteration": true,
+    "jsx": "preserve",
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "strictNullChecks": true
+  },
+  "include": ["next-env.d.ts", ".next/types/**/*.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}