autonomic-cooperative/nextload
0
0
Fork 0
Code Issues 11 Pull Requests Packages Projects Releases Wiki Activity

Cleanup README

Browse Source
This commit is contained in:
tobias 2024-06-19 21:33:32 +02:00
parent 82d5beaa90
commit 6b49eebeb8
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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 ## Get started with nextload
### Prerequisites: ### Prerequisites:
**node** **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) 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** **pnpm**
When node is installed, run `corepack enable pnpm` to install pnpm `corepack enable pnpm`
**docker** **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 curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh sudo sh get-docker.sh
@ -29,6 +27,8 @@ sudo sh get-docker.sh
`pnpm dev` `pnpm dev`
### Technical details ### Technical details
Nextload is a fork of [payload 3 demo](https://github.com/payloadcms/payload-3.0-demo)
**The app folder** **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. 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.