From b5e7af25885aae1f498e18f4abb3c0c64f2fa469 Mon Sep 17 00:00:00 2001 From: Ronald Aveling Date: Thu, 26 Aug 2021 17:36:35 +1000 Subject: [PATCH 1/4] POC commit --- examples/task-manager/README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/examples/task-manager/README.md b/examples/task-manager/README.md index 03066141ffa..29e05c9f2f9 100644 --- a/examples/task-manager/README.md +++ b/examples/task-manager/README.md @@ -2,28 +2,32 @@ This base project implements a simple **Task Management** app, with `Tasks` and `People` who can be assigned to tasks. -You can it as a starting place for learning how to use Keystone. -It’s also a starter for other [feature projects](../). +Use it as a starting place for learning how to use Keystone. ## Instructions -To run this project, clone the Keystone repository locally then navigate to this directory and run: +To run this project: -```shell -yarn dev -``` +1. Clone the Keystone repository locally +2. Navigate to this directory `cd /examples/task-manager` +3. Run: `yarn dev` -This will start the Admin UI at [localhost:3000](http://localhost:3000). +This will start Keystone’s Admin UI at [localhost:3000](http://localhost:3000), where you can add items to an empty database. -You can use the Admin UI to create items in your database. +You can also access Keystone’s GraphQL Playground at [localhost:3000/api/graphql](http://localhost:3000/api/graphql) to explore the GraphQL API, and run [queries](https://keystonejs.com/docs/guides/filters) and [mutations](https://keystonejs.com/docs/apis/graphql#mutations) on your data. -You can also access a GraphQL Playground at [localhost:3000/api/graphql](http://localhost:3000/api/graphql), which allows you to directly run GraphQL queries and mutations. +Congratulations, you’re now up and running with Keystone! 🚀 -🚀 Congratulations, you're now up and running with Keystone! +### Optional: add sample data + +This example includes sample data. To add it to your database: + +1. Ensure you’ve initialised your project with `yarn dev` at least once. +2. Run `yarn seed-data`. This will populate your database with sample content. +3. Run `yarn dev` again to startup Admin UI with sample data in place. ## Next steps -This project is bare bones, and doesn't use any of Keystone's advanced features. -We encourage you to experiment with the code here to see how Keystone works, become familiar with the Admin UI, and learn about the GraphQL Playground. +Experiment with the code in this example to see how Keystone works, familiarise yourself with the Admin UI, and learn about the GraphQL Playground. -When you've got the hang of the Task Manager, try a [feature project](../) to learn Keystone's advanced features and take your knowledge to the next level. +When you’ve got the hang of this base project, try a [feature project](../) to learn Keystone’s advanced features and take your knowledge to the next level. From 5dc6873e0f33754c8b19ee85aebec0402729688a Mon Sep 17 00:00:00 2001 From: Ronald Aveling Date: Thu, 26 Aug 2021 17:38:21 +1000 Subject: [PATCH 2/4] Typo --- examples/task-manager/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/task-manager/README.md b/examples/task-manager/README.md index 29e05c9f2f9..e4b4f36ff92 100644 --- a/examples/task-manager/README.md +++ b/examples/task-manager/README.md @@ -10,7 +10,7 @@ To run this project: 1. Clone the Keystone repository locally 2. Navigate to this directory `cd /examples/task-manager` -3. Run: `yarn dev` +3. Run `yarn dev` This will start Keystone’s Admin UI at [localhost:3000](http://localhost:3000), where you can add items to an empty database. From 201bdd1a8834fa91df95c12928bf522423b2a353 Mon Sep 17 00:00:00 2001 From: Ronald Aveling Date: Fri, 27 Aug 2021 15:11:54 +1000 Subject: [PATCH 3/4] Update examples/task-manager/README.md Co-authored-by: Tim Leslie --- examples/task-manager/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/task-manager/README.md b/examples/task-manager/README.md index e4b4f36ff92..87431499f2d 100644 --- a/examples/task-manager/README.md +++ b/examples/task-manager/README.md @@ -9,7 +9,7 @@ Use it as a starting place for learning how to use Keystone. To run this project: 1. Clone the Keystone repository locally -2. Navigate to this directory `cd /examples/task-manager` +2. Navigate to this directory `cd examples/task-manager` 3. Run `yarn dev` This will start Keystone’s Admin UI at [localhost:3000](http://localhost:3000), where you can add items to an empty database. From 1e26bd114fcded9d06503ed74aabea5c02a7d004 Mon Sep 17 00:00:00 2001 From: Ronald Aveling Date: Fri, 27 Aug 2021 15:17:12 +1000 Subject: [PATCH 4/4] Edits to blog README --- examples/blog/README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/examples/blog/README.md b/examples/blog/README.md index 4f70b318e2f..5bc8b3be47f 100644 --- a/examples/blog/README.md +++ b/examples/blog/README.md @@ -2,29 +2,33 @@ This project implements a basic **Blog**, with `Posts` and `Authors`. -You can use it as a starting place for learning how to use Keystone. +Use it as a starting place for learning how to use Keystone. ## Instructions -To run this project, clone the Keystone repository locally then navigate to this directory and run: +To run this project: -```shell -yarn dev -``` +1. Clone the Keystone repository locally +2. Navigate to this directory `cd examples/blog` +3. Run `yarn dev` This will start the Admin UI at [localhost:3000](http://localhost:3000). You can use the Admin UI to create items in your database. You can also access a GraphQL Playground at [localhost:3000/api/graphql](http://localhost:3000/api/graphql), which allows you to directly run GraphQL queries and mutations. -🚀 Congratulations, you're now up and running with Keystone! +Congratulations, you're now up and running with Keystone! 🚀 -## Next steps +### Optional: add sample data + +This example includes sample data. To add it to your database: -This project is bare bones, and doesn't use any of Keystone's advanced features. -We encourage you to experiment with the code here to see how Keystone works, become familiar with the Admin UI, and learn about the GraphQL Playground. +1. Ensure you’ve initialised your project with `yarn dev` at least once. +2. Run `yarn seed-data`. This will populate your database with sample content. +3. Run `yarn dev` again to startup Admin UI with sample data in place. + +## Next steps -Once you've got the hang of using this project, you can check out the [feature examples](../). -These projects build on this starter project and show you how to use Keystones advanced features to take your project to the next level. +Experiment with the code in this example to see how Keystone works, familiarise yourself with the Admin UI, and learn about the GraphQL Playground. -When you've got the hang of the Blog app, try a [feature project](../) to learn Keystone's advanced features and take your knowledge to the next level. +When you’ve got the hang of this base project, try a [feature project](../) to learn Keystone’s advanced features and take your knowledge to the next level.