TopHatCroat/nextjs-payloadcms-demo

Simple blog page with NextJS and PayloadCMS

NextJS + PayloadCMS Demo

🎯 Getting Started

To get started with this boilerplate, follow these steps:

1. Clone repository:

git clone https://github.com/TopHatCroat/nextjs-payloadcms-demo.git

2. Install turbo and install packages:

yarn global add turbo
yarn install

3. Start a local MongoDB database using Docker:

docker run -d -p 27017:27017 mongo

4. Generate a .env file for the backend:

cp apps/backend/.env.template apps/backend/.env

5. Generate seed data for the backend:

turbo seed

6. Run the development servers for both the frontend and backend

turbo dev

7. Access the UIs:
   • Open http://localhost:3000 with your browser to see the admin UI
   • Open http://localhost:3100 with your browser to see the UI

📜 API Documentation

API documentation is provided by payload-openapi plugin. The full documentation is available in apps/backend/openapi.yaml.

🚘 Auto-generated REST API

If you changed or added new content types, you can regenerate the REST API documentation by running the following command:

turbo generate:rest-api

🚀 Deployment

// TODO

Contributing

Contributions are always welcome! To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name.
3. Make your changes, and commit
4. Push your changes to the forked repository.
5. Create a pull request, and we'll review your changes.

Acknowledgements

Thanks to next-enterprise for providing the base for the frontend. Thanks to Payload CMS for providing the backend headless CMS for this project.