Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update example READMEs with seed data instructions #6419

Merged
merged 5 commits into from
Aug 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions examples/blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 youve got the hang of this base project, try a [feature project](../) to learn Keystones advanced features and take your knowledge to the next level.
30 changes: 17 additions & 13 deletions examples/task-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 youve got the hang of this base project, try a [feature project](../) to learn Keystones advanced features and take your knowledge to the next level.