create-keystone-app 5.0.0 → 6.0.0

package/starter/schema.prisma

@@ -12,28 +12,28 @@ generator client {
 }
 
 model User {
-  id       String  @id @default(cuid())
-  name     String?
-  email    String? @unique
-  password String?
-  posts    Post[]  @relation("Post_author")
+  id       String @id @default(cuid())
+  name     String @default("")
+  email    String @unique @default("")
+  password String
+  posts    Post[] @relation("Post_author")
 }
 
 model Post {
   id          String    @id @default(cuid())
-  title       String?
-  status      String?
-  content     String?
+  title       String    @default("")
+  status      String?   @default("draft")
+  content     String    @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
   publishDate DateTime?
   author      User?     @relation("Post_author", fields: [authorId], references: [id])
   authorId    String?   @map("author")
-  tags        Tag[]     @relation("Post_tags_Tag_posts")
+  tags        Tag[]     @relation("Post_tags")
 
   @@index([authorId])
 }
 
 model Tag {
-  id    String  @id @default(cuid())
-  name  String?
-  posts Post[]  @relation("Post_tags_Tag_posts")
+  id    String @id @default(cuid())
+  name  String @default("")
+  posts Post[] @relation("Post_tags")
 }

package/starter/schema.ts

@@ -1,43 +1,88 @@
-import { createSchema, list } from '@keystone-next/keystone';
+/*
+Welcome to the schema! The schema is the heart of Keystone.
+
+Here we define our 'lists', which will then be used both for the GraphQL
+API definition, our database tables, and our Admin UI layout.
+
+Some quick definitions to help out:
+A list: A definition of a collection of fields with a name. For the starter
+  we have `User`, `Post`, and `Tag` lists.
+A field: The individual bits of data on your list, each with its own type.
+  you can see some of the lists in what we use below.
+
+*/
+
+// Like the `config` function we use in keystone.ts, we use functions
+// for putting in our config so we get useful errors. With typescript,
+// we get these even before code runs.
+import { list } from '@keystone-6/core';
+
+// We're using some common fields in the starter. Check out https://keystonejs.com/docs/apis/fields#fields-api
+// for the full list of fields.
 import {
   text,
   relationship,
   password,
   timestamp,
   select,
-} from '@keystone-next/keystone/fields';
-import { document } from '@keystone-next/fields-document';
+} from '@keystone-6/core/fields';
+// The document field is a more complicated field, so it's in its own package
+// Keystone aims to have all the base field types, but you can make your own
+// custom ones.
+import { document } from '@keystone-6/fields-document';
 
-export const lists = createSchema({
+// We have a users list, a blogs list, and tags for blog posts, so they can be filtered.
+// Each property on the exported object will become the name of a list (a.k.a. the `listKey`),
+// with the value being the definition of the list, including the fields.
+export const lists = {
+  // Here we define the user list.
   User: list({
-    ui: {
-      listView: {
-        initialColumns: ['name', 'posts'],
-      },
-    },
+    // Here are the fields that `User` will have. We want an email and password so they can log in
+    // a name so we can refer to them, and a way to connect users to posts.
     fields: {
-      name: text({ isRequired: true }),
+      name: text({ validation: { isRequired: true } }),
       email: text({
-        isRequired: true,
+        validation: { isRequired: true },
         isIndexed: 'unique',
         isFilterable: true,
       }),
-      password: password({ isRequired: true }),
+      // The password field takes care of hiding details and hashing values
+      password: password({ validation: { isRequired: true } }),
+      // Relationships allow us to reference other lists. In this case,
+      // we want a user to have many posts, and we are saying that the user
+      // should be referencable by the 'author' field of posts.
+      // Make sure you read the docs to understand how they work: https://keystonejs.com/docs/guides/relationships#understanding-relationships
       posts: relationship({ ref: 'Post.author', many: true }),
     },
+    // Here we can configure the Admin UI. We want to show a user's name and posts in the Admin UI
+    ui: {
+      listView: {
+        initialColumns: ['name', 'posts'],
+      },
+    },
   }),
+  // Our second list is the Posts list. We've got a few more fields here
+  // so we have all the info we need for displaying posts.
   Post: list({
     fields: {
       title: text(),
+      // Having the status here will make it easy for us to choose whether to display
+      // posts on a live site.
       status: select({
         options: [
           { label: 'Published', value: 'published' },
           { label: 'Draft', value: 'draft' },
         ],
+        // We want to make sure new posts start off as a draft when they are created
+        defaultValue: 'draft',
+        // fields also have the ability to configure their appearance in the Admin UI
         ui: {
           displayMode: 'segmented-control',
         },
       }),
+      // The document field can be used for making highly editable content. Check out our
+      // guide on the document field https://keystonejs.com/docs/guides/document-fields#how-to-use-document-fields
+      // for more information
       content: document({
         formatting: true,
         layouts: [
@@ -51,6 +96,8 @@ export const lists = createSchema({
         dividers: true,
       }),
       publishDate: timestamp(),
+      // Here is the link from post => author.
+      // We've configured its UI display quite a lot to make the experience of editing posts better.
       author: relationship({
         ref: 'User.posts',
         ui: {
@@ -61,6 +108,7 @@ export const lists = createSchema({
           inlineCreate: { fields: ['name', 'email'] },
         },
       }),
+      // We also link posts to tags. This is a many <=> many linking.
       tags: relationship({
         ref: 'Tag.posts',
         ui: {
@@ -75,16 +123,14 @@ export const lists = createSchema({
       }),
     },
   }),
+  // Our final list is the tag list. This field is just a name and a relationship to posts
   Tag: list({
     ui: {
       isHidden: true,
     },
     fields: {
       name: text(),
-      posts: relationship({
-        ref: 'Post.tags',
-        many: true,
-      }),
+      posts: relationship({ ref: 'Post.tags', many: true }),
     },
   }),
-});
+};

package/CHANGELOG.md

@@ -1,151 +0,0 @@
-# create-keystone-app
-
-## 5.0.0
-
-### Major Changes
-
-- [#201](https://github.com/keystonejs/create-keystone-app/pull/201) [`ee98fdb`](https://github.com/keystonejs/create-keystone-app/commit/ee98fdba87ee303e47790aa146575316de299fb6) Thanks [@Noviny](https://github.com/Noviny)! - Switch to use sqlite as the default database
-
-## 4.0.15
-
-### Patch Changes
-
-- [#199](https://github.com/keystonejs/create-keystone-app/pull/199) [`fe7523d`](https://github.com/keystonejs/create-keystone-app/commit/fe7523dc1ee04d46a7d506554418fd3812729b46) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.14
-
-### Patch Changes
-
-- [#194](https://github.com/keystonejs/create-keystone-app/pull/194) [`16614e1`](https://github.com/keystonejs/create-keystone-app/commit/16614e10160b2b0899ec0fe7cad5e3eeff129b3c) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.13
-
-### Patch Changes
-
-- [#188](https://github.com/keystonejs/create-keystone-app/pull/188) [`621adbe`](https://github.com/keystonejs/create-keystone-app/commit/621adbe62de80a79b0759d3e806816b4097bb2a7) Thanks [@bladey](https://github.com/bladey)! - Updated Keystone dependencies to latest version.
-
-## 4.0.12
-
-### Patch Changes
-
-- [#173](https://github.com/keystonejs/create-keystone-app/pull/173) [`b8cf267`](https://github.com/keystonejs/create-keystone-app/commit/b8cf26719456a0c88788f6d6ea3fec05af2b57a6) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.11
-
-### Patch Changes
-
-- [#166](https://github.com/keystonejs/create-keystone-app/pull/166) [`c853425`](https://github.com/keystonejs/create-keystone-app/commit/c8534250489c33e40323a69c41e644d7199f7329) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.10
-
-### Patch Changes
-
-- [#157](https://github.com/keystonejs/create-keystone-app/pull/157) [`437237f`](https://github.com/keystonejs/create-keystone-app/commit/437237f671ae40fdbd1bed19ebc272cbb31cbfe6) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.9
-
-### Patch Changes
-
-- [#150](https://github.com/keystonejs/create-keystone-app/pull/150) [`2af99bf`](https://github.com/keystonejs/create-keystone-app/commit/2af99bf669114eb3cd562abb707729a24aee533e) Thanks [@bladey](https://github.com/bladey)! - Updated Keystone dependencies to latest version.
-
-## 4.0.8
-
-### Patch Changes
-
-- [#143](https://github.com/keystonejs/create-keystone-app/pull/143) [`4aa566a`](https://github.com/keystonejs/create-keystone-app/commit/4aa566a8c2dccfab1264518f90d62899b467f15d) Thanks [@bladey](https://github.com/bladey)! - Updated Keystone dependencies to latest version.
-
-  Updated README with getting starting instructions.
-
-## 4.0.7
-
-### Patch Changes
-
-- [#137](https://github.com/keystonejs/create-keystone-app/pull/137) [`a779d69`](https://github.com/keystonejs/create-keystone-app/commit/a779d691f385d152478d49a5f01ceb1bc0cc69ac) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.6
-
-### Patch Changes
-
-- [#122](https://github.com/keystonejs/create-keystone-app/pull/122) [`60f1454`](https://github.com/keystonejs/create-keystone-app/commit/60f1454e354f37a587a75d7cb54c165862fc392d) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.5
-
-### Patch Changes
-
-- [#116](https://github.com/keystonejs/create-keystone-app/pull/116) [`d532c8f`](https://github.com/keystonejs/create-keystone-app/commit/d532c8fcc243fd4d37d45a47eb4a1c7698fca494) Thanks [@bladey](https://github.com/bladey)! - Updated Keystone dependencies to latest version.
-
-## 4.0.4
-
-### Patch Changes
-
-- [#101](https://github.com/keystonejs/create-keystone-app/pull/101) [`446bf0e`](https://github.com/keystonejs/create-keystone-app/commit/446bf0e745e30d814a438c81eb8f7dd275174ff9) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.3
-
-### Patch Changes
-
-- [#97](https://github.com/keystonejs/create-keystone-app/pull/97) [`4e47f27`](https://github.com/keystonejs/create-keystone-app/commit/4e47f27aa9f5925b6346960ee080758c8bfe34df) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies to latest version.
-
-## 4.0.2
-
-### Patch Changes
-
-- [#94](https://github.com/keystonejs/create-keystone-app/pull/94) [`be83fa6`](https://github.com/keystonejs/create-keystone-app/commit/be83fa60e004a2f11e65a0bc553312732912a828) Thanks [@bladey](https://github.com/bladey)! - Updated Keystone dependencies to latest version.
-
-## 4.0.1
-
-### Patch Changes
-
-- [#74](https://github.com/keystonejs/create-keystone-app/pull/74) [`79f19f5`](https://github.com/keystonejs/create-keystone-app/commit/79f19f51a6648941c15ac4f03bc0807a5670cb55) Thanks [@timleslie](https://github.com/timleslie)! - Updated `password` field in starter project to be `{ isRequired: true }`.
-
-## 4.0.0
-
-### Major Changes
-
-- [#65](https://github.com/keystonejs/create-keystone-next-app/pull/65) [`49c5ff2`](https://github.com/keystonejs/create-keystone-next-app/commit/49c5ff2d9892de0692a05a1f1dc01501f2979bc8) Thanks [@bladey](https://github.com/bladey)! - Updated to use Keystone Next packages instead of Keystone 5.
-
-## 1.2.2
-
-### Patch Changes
-
-- [#66](https://github.com/keystonejs/create-keystone-next-app/pull/66) [`f44867a`](https://github.com/keystonejs/create-keystone-next-app/commit/f44867a56626824e96a2135b2ec1eee07da9fde5) Thanks [@bladey](https://github.com/bladey)! - Added notice to advise users to use `create-keystone-app` instead of `create-keystone-next-app`.
-
-## 1.2.1
-
-### Patch Changes
-
-- [#52](https://github.com/keystonejs/create-keystone-next-app/pull/52) [`1b363c4`](https://github.com/keystonejs/create-keystone-next-app/commit/1b363c41cd96299e68cd3d9db3be94b13a7844e5) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies.
-
-## 1.2.0
-
-### Minor Changes
-
-- [#30](https://github.com/keystonejs/create-keystone-next-app/pull/30) [`fb45d53`](https://github.com/keystonejs/create-keystone-next-app/commit/fb45d53445ba2ec1fb30680e90c293d40c293d00) Thanks [@jesstelford](https://github.com/jesstelford)! - Updated script to show a loading spinner instead of the raw yarn or npm output.
-
-### Patch Changes
-
-- [#36](https://github.com/keystonejs/create-keystone-next-app/pull/36) [`94f9f26`](https://github.com/keystonejs/create-keystone-next-app/commit/94f9f267eea6862605ca443a83997062eeeb6b92) Thanks [@renovate](https://github.com/apps/renovate)! - Updated Keystone dependencies.
-
-* [#46](https://github.com/keystonejs/create-keystone-next-app/pull/46) [`9cbc860`](https://github.com/keystonejs/create-keystone-next-app/commit/9cbc8608c42c4406e574dad12e2f871754ff5450) Thanks [@dominikwilkowski](https://github.com/dominikwilkowski)! - Fixed a windows issue where the package would not run via npx or npm init
-
-- [#50](https://github.com/keystonejs/create-keystone-next-app/pull/50) [`ceca306`](https://github.com/keystonejs/create-keystone-next-app/commit/ceca306853469eda199dc3d7b1c8ee411f414e9b) Thanks [@dominikwilkowski](https://github.com/dominikwilkowski)! - Updated keystone-next dependencies
-
-* [#28](https://github.com/keystonejs/create-keystone-next-app/pull/28) [`b52d27e`](https://github.com/keystonejs/create-keystone-next-app/commit/b52d27e4d2ad447cf4a5a268c6ccda65723d8d2f) Thanks [@dominikwilkowski](https://github.com/dominikwilkowski)! - Removed a single trailing space in tsconfig.json
-
-## 1.1.0
-
-### Minor Changes
-
-- [#24](https://github.com/keystonejs/create-keystone-next-app/pull/24) [`736c845`](https://github.com/keystonejs/create-keystone-next-app/commit/736c845d677e8520cb2263b5ae9122c1cc1590bf) Thanks [@mitchellhamilton](https://github.com/mitchellhamilton)! - Updated Keystone
-
-## 1.0.0
-
-### Major Changes
-
-- [`4f63ae3`](https://github.com/keystonejs/create-keystone-next-app/commit/4f63ae383f1995ba7494390717f628bed135d7b0) [#15](https://github.com/keystonejs/create-keystone-next-app/pull/15) Thanks [@mitchellhamilton](https://github.com/mitchellhamilton)! - Updated to the latest version of Keystone Next
-
-## 0.0.1
-
-### Patch Changes
-
-- [`201af8b`](https://github.com/keystonejs/create-keystone-next-app/commit/201af8b9b96edf5f63cf36c1540393f34fe06848) Thanks [@mitchellhamilton](https://github.com/mitchellhamilton)! - Improved output after creating project