diff --git a/README.md b/README.md index 6bf949e..552683e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ -Nextload is a fork of the official [payload 3 demo](https://github.com/payloadcms/payload-3.0-demo) - ## Get started with nextload ### Prerequisites: **node** Using a version manager for installing node is recommended, see [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) **pnpm** -When node is installed, run `corepack enable pnpm` to install pnpm +`corepack enable pnpm` **docker** -Using the [get docker script](https://get.docker.com/), run: +[get docker script](https://get.docker.com/): ``` curl -fsSL https://get.docker.com -o get-docker.sh sudo sh get-docker.sh @@ -29,6 +27,8 @@ sudo sh get-docker.sh `pnpm dev` ### Technical details +Nextload is a fork of [payload 3 demo](https://github.com/payloadcms/payload-3.0-demo) + **The app folder** You'll see that Payload requires a few files to be present in your `/app` folder. There are files for the admin UI as well as files for all route handlers. We've consolidated all admin views into a single `page.tsx` and consolidated most of the REST endpoints into a single `route.ts` file for simplicity, but also for development performance. With this pattern, you only have to compile the admin UI / REST API / GraphQL API a single time - and from there, it will be lightning-fast.