pxlr-cms
v1.0.9
Published
Modern, open-source Headless CMS for developers
Downloads
38
Maintainers
Readme
PXLR CMS
Modern, open-source Headless CMS for developers. Build content-driven applications with full control over your data and infrastructure.
- Один шаг до старта:
npx pxlr-cms@latest— интерактивное создание проекта (Docker или Standalone, шаблон Clean/Blog). - Гибкая установка: флаги CLI как у create-payload-app:
-t,--use-npm/--use-pnpm/--use-yarn,--no-deps,--force. - Обновление без переустановки:
npx pxlr-cms upgrade— подстановка актуальных шаблонов с сохранением.envи имён пакетов. - Свой бэкенд: API (Fastify), админка (Next.js), опциональный фронт (Blog). PostgreSQL, Redis, S3-совместимое хранилище. Подробности подключения к своим серверам — в файле CONNECTION.md в папке
pxlr-cmsсозданного проекта.
Software requirements
- Node.js 18+
- Package manager: pnpm (recommended), npm or yarn — install pnpm
- Standalone: PostgreSQL, Redis, S3-compatible storage (or use Docker)
Features
- Schema-driven content — Define content types with TypeScript
- Rich text editor — Powerful TipTap-based editor with formatting, images, and embeds
- Media library — S3-compatible storage with drag-and-drop uploads
- Content versioning — Full history with diff view and instant rollback
- Real-time collaboration — WebSocket-powered live updates
- Internationalization — Built-in multi-language support (RU/EN)
- REST API — Complete CRUD API with authentication
- Modern stack — Next.js, React, TailwindCSS, PostgreSQL
Quick start
Создание нового проекта (интерактивно):
npx pxlr-cms@latestСледуйте подсказкам — будет создана папка проекта с API, админкой и при выборе Blog — фронтом.
Usage (CLI, как у create-payload-app)
npx pxlr-cms@latest
npx pxlr-cms@latest my-project
npx pxlr-cms@latest -n my-project -t blog| Option | Description |
|--------|-------------|
| [project-name] | Имя папки проекта (можно также через -n) |
| -n, --name <name> | Имя проекта |
| -t, --template <template> | Шаблон: clean | blog |
| --use-npm | Установка зависимостей через npm |
| --use-yarn | Установка зависимостей через yarn |
| --use-pnpm | Установка зависимостей через pnpm (по умолчанию) |
| --no-deps | Не устанавливать зависимости после создания (запустите pnpm install:all или npm run install:all сами) |
| -f, --force | Перезаписать существующую папку без запроса |
| upgrade | Обновить существующий проект до актуального шаблона (из корня проекта) |
Installation Options
Docker (Recommended)
Full self-contained setup with all services included:
- PostgreSQL database
- Redis cache
- MinIO S3 storage
- API server
- Admin panel
npx pxlr-cms@latest my-project
cd my-project/pxlr-cms
docker-compose up -dAccess:
- Admin Panel: http://localhost:3333
- API: http://localhost:4000
- MinIO Console: http://localhost:9011
Standalone
Connect to your existing infrastructure:
npx pxlr-cms@latest my-project
# Select: Standalone installation
cd my-project/pxlr-cms # обязательно зайти в pxlr-cms
pnpm install:all # установка зависимостей (корень + API + Admin + frontend)
# Настрой packages/api/.env — DATABASE_URL, S3, JWT_SECRET
pnpm dev # запуск API и Admin одной командойОтдельно: pnpm dev:api и pnpm dev:admin в двух терминалах. Требуется pnpm (установка).
Upgrading
Чтобы обновить уже установленный проект до новой версии шаблонов (без переустановки с нуля):
cd my-project
npx pxlr-cms upgradeКоманда сохраняет ваши .env и .env.local, имена пакетов и подставляет актуальные файлы из шаблона. После обновления при необходимости переустановите зависимости: cd pxlr-cms && pnpm install:all, во фронте — pnpm install.
Templates
| Option | Description | |--------|-------------| | Connection | Docker (full stack) or Custom (.env) — your own DB and S3 | | Clean | Empty CMS, ready for your schemas | | Blog | Pre-configured blog (schemas, types, frontend); optional demo content (sample posts) |
Default Credentials
- Email: [email protected]
- Password: admin123
Configuration
API Environment Variables
PORT=4000
NODE_ENV=development
DATABASE_URL=postgresql://user:pass@localhost:5432/pxlr
REDIS_URL=redis://localhost:6379
S3_ENDPOINT=s3.amazonaws.com
S3_ACCESS_KEY=your-key
S3_SECRET_KEY=your-secret
S3_BUCKET=pxlr-media
S3_PUBLIC_URL=https://your-bucket.s3.amazonaws.com
JWT_SECRET=your-secret-keyAdmin Environment Variables
NEXT_PUBLIC_API_URL=http://localhost:4000Project Structure
my-project/
├── pxlr-cms/
│ ├── packages/
│ │ ├── api/ # Fastify REST API
│ │ ├── admin/ # Next.js admin panel
│ │ └── shared/ # TypeScript types
│ ├── docker-compose.yml
│ └── nginx/
└── frontend/ # Optional Next.js frontendSupported Storage Providers
- MinIO (self-hosted)
- AWS S3
- Cloudflare R2
- DigitalOcean Spaces
- Backblaze B2
- Any S3-compatible service
Technology Stack
| Layer | Technology | |-------|------------| | Backend | Node.js, Fastify, TypeScript | | Frontend | Next.js 15, React 18, TailwindCSS | | Database | PostgreSQL 16 | | Cache | Redis 7 | | Storage | S3-compatible | | Editor | TipTap |
Changelog
Список изменений по версиям — в CHANGELOG.md.
| Версия | Основные изменения |
|--------|---------------------|
| 1.0.9 | CLI в стиле Payload: -t, --use-npm/yarn/pnpm, --no-deps, --force; автоустановка после создания; уточнения в README и CONNECTION (cd pxlr-cms). |
| 1.0.8 | Везде указан pnpm: скрипты и инструкции используют pnpm. |
| 1.0.7 | CONNECTION.md (подключение к своим серверам); install:all ставит и фронт; скрипты на npm --prefix. |
| 1.0.6 | Upgrade: исправление невалидного scope (@./admin → @pxlr-cms-app/admin); сохранение типа установки (standalone без Docker). |
| 1.0.5 | Команда npx pxlr-cms upgrade — обновление существующего проекта без переустановки (сохраняются .env и имена пакетов). |
| 1.0.4 | Исправлено имя пакета админки при установке в .; единые скрипты install:all и dev; .env.example для фронта; Next.js 16 / React 19 в шаблоне Blog. |
| 1.0.3 | Публикация в npm. |
Documentation
License
MIT License © 2026 Pixel & Layer
