https://github.com/payloadcms/blank
https://github.com/payloadcms/blank
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/payloadcms/blank
- Owner: payloadcms
- Created: 2023-08-05T15:57:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-05T15:57:09.000Z (almost 2 years ago)
- Last Synced: 2025-01-05T23:12:21.598Z (6 months ago)
- Size: 146 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Payload Blank Template
A blank template for [Payload](https://github.com/payloadcms/payload) to help you get up and running quickly. This repo may have been created by running `npx create-payload-app` and selecting the "blank" template or by cloning this template on [Payload Cloud](https://payloadcms.com/new/clone/blank).
## 🛠️ Development
To spin up the project locally, follow these steps:
1. First clone the repo
1. Then `cd YOUR_PROJECT_REPO && cp .env.example .env`
1. Next `yarn && yarn dev` (or `docker-compose up`, see [Docker](#docker))
1. Now open `http://localhost:3000/admin` in your browser
1. 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](https://www.docker.com) to spin up this project locally. To do so, follow these steps:
1. Follow [steps 1 and 2 from above](#development), the docker-compose file will automatically use the `.env` file in your project root
1. Next run `docker-compose up`
1. Follow [steps 4 and 5 from above](#development) 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:
1. 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.
1. 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](https://payloadcms.com/new/import), a one-click hosting solution to deploy production-ready instances of your Payload apps directly from your GitHub repo. You can also deploy for app manually, check out the [deployment documentation](https://payloadcms.com/docs/production/deployment) for full details.