Skip to content

Commit

Permalink
docs: fix readme (#8941)
Browse files Browse the repository at this point in the history
  • Loading branch information
duidae authored Dec 3, 2023
1 parent d94efe7 commit bbee707
Show file tree
Hide file tree
Showing 27 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion examples/custom-admin-ui-logo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates how to create a custom logo in the Admin UI.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-admin-ui-navigation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates how to create a custom Navigation component for use in

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-admin-ui-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Task Manager](../task-manager) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-field-view/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates how to create a custom field view for a JSON field. Th

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-field/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates how to create different types of custom fields

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-session-invalidation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Authentication example](../with-auth) project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-session-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Authentication](../with-auth) example.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/default-values/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This example builds on the [TODO](../usecase-todo) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/document-field/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Blog](../blog) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/extend-express-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates how to create REST endpoints by extending Keystone's e

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/extend-graphql-schema-graphql-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Blog](../blog) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/extend-graphql-schema-graphql-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Blog](../blog) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/extend-graphql-schema-nexus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This project demonstrates how to use [Nexus](https://nexusjs.org) to extend the

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/extend-graphql-subscriptions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ subscription PostUpdated {

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/extend-prisma-schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ These show three separate ways of mutating the Prisma Schema see `keystone.ts` a

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of this repository, then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of this repository, then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/framework-nextjs-two-servers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ An example of a frontend nextjs server and backend API server
Make sure you are at the root of the repo and install dependencies.

```shell
pnpm
pnpm install
```

2. Start Keystone and Next.js servers
Expand Down
2 changes: 1 addition & 1 deletion examples/graphql-ts-gql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Virtual Field](../virtual-field) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/limits/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates usage of different limits you can add to your GraphQL

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of this repository, then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of this repository, then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/reuse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Reuse is not encouraged typically, but it can be helpful in projects that have g

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/script/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The `getContext` function does not adhere to the typical Keystone entry-point an

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of this repository, then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of this repository, then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [`withAuth()`](../with-auth) example project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/usecase-blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use it as a starting place for learning how to use Keystone.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of this repository, then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of this repository, then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/usecase-relationship-union/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This can be useful when trying to use represent union (or sum) types in a list,

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of this repository, then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of this repository, then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/usecase-roles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The permissions affect both the Admin UI and GraphQL API.
To run the project locally:

- Clone this repo
- Run `pnpm` in the root (this repo is a monorepo and uses pnpm workspaces, so that will install everything you'll need)
- Run `pnpm install` in the root (this repo is a monorepo and uses pnpm workspaces, so that will install everything you'll need)
- Open this folder in your terminal and run `pnpm dev`

If everything works 🤞 the GraphQL Server and Admin UI will start on [localhost:3000](http://localhost:3000)
2 changes: 1 addition & 1 deletion examples/usecase-todo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use it as a starting place for learning how to use Keystone.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/usecase-versioning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project demonstrates a Posts list where a particular field is always requir

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of this repository, then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of this repository, then navigate to this directory and run:

```shell
pnpm dev
Expand Down
2 changes: 1 addition & 1 deletion examples/virtual-field/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It builds on the [Blog](../blog) starter project.

## Instructions

To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
To run this project, clone the Keystone repository locally, run `pnpm install` at the root of the repository then navigate to this directory and run:

```shell
pnpm dev
Expand Down

0 comments on commit bbee707

Please sign in to comment.