Files

Alessio Gravili 9bd9e7a986 feat!: upgrade minimum node 20 version from 20.6.0 to 20.9.0 (#6659 )

**BREAKING**:
- This bumps the minimum required node version from node 20.6.0 to node
20.9.0. This is because 20.6.0 breaks type generation due to a CJS node
bug, and 20.9.0 is the next v20 LTS version. The minimum node 18 version
stays the same (18.20.2)

2024-06-06 17:15:21 +00:00

src

chore(templates): add generated templates [no-lint] (#6604 )

2024-06-05 15:39:28 -04:00

.env.example

chore: adds blank 3.0 template (#5330 )

2024-03-14 09:59:36 -04:00

.eslintrc.cjs

chore(templates): enable next lint on blank (#6494 )

2024-05-24 11:36:50 -04:00

.gitignore

chore: adds blank 3.0 template (#5330 )

2024-03-14 09:59:36 -04:00

.prettierrc.json

chore: adds blank 3.0 template (#5330 )

2024-03-14 09:59:36 -04:00

.yarnrc

fix(templates): yarn install broken for new template installs (#6283 )

2024-05-09 10:17:09 -04:00

docker-compose.yml

chore(templates): update dockerfile and docker-compose for blank template (#6536 )

2024-05-28 12:35:05 -04:00

Dockerfile

chore(templates): update dockerfile and docker-compose for blank template (#6536 )

2024-05-28 12:35:05 -04:00

next.config.mjs

chore: update blank 3.0 template for withPayload change

2024-04-10 13:41:11 -04:00

package.json

feat!: upgrade minimum node 20 version from 20.6.0 to 20.9.0 (#6659 )

2024-06-06 17:15:21 +00:00

README.md

chore: adds blank 3.0 template (#5330 )

2024-03-14 09:59:36 -04:00

tsconfig.json

fix(templates): blank-3.0: pin next version, as it was breaking new installs (#6281 )

2024-05-09 10:05:38 -04:00

README.md

Payload Blank Template

A blank template for Payload to help you get up and running quickly. This repo may have been created by running npx create-payload-app@latest and selecting the "blank" template or by cloning this template on Payload Cloud.

See the official Examples Directory for details on how to use Payload in a variety of different ways.

Development

To spin up the project locally, follow these steps:

First clone the repo
Then cd YOUR_PROJECT_REPO && cp .env.example .env
Next yarn && yarn dev (or docker-compose up, see Docker)
Now open http://localhost:3000/admin to access the admin panel
Create your first admin user using the form on the page

That's it! Changes made in ./src will be reflected in your app.

Docker

Alternatively, you can use Docker to spin up this project locally. To do so, follow these steps:

Follow steps 1 and 2 from above, the docker-compose file will automatically use the .env file in your project root
Next run docker-compose up
Follow steps 4 and 5 from above to login and create your first admin user

That's it! The Docker instance will help you get up and running quickly while also standardizing the development environment across your teams.

Production

To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:

First invoke the payload build script by running yarn build or npm run build in your project root. This creates a ./build directory with a production-ready admin bundle.
Then run yarn serve or npm run serve to run Node in production and serve Payload from the ./build directory.

Deployment

The easiest way to deploy your project is to use Payload Cloud, a one-click hosting solution to deploy production-ready instances of your Payload apps directly from your GitHub repo. You can also deploy your app manually, check out the deployment documentation for full details.

Questions

If you have any issues or questions, reach out to us on Discord or start a GitHub discussion.