Skip to content

README.md

Latest commit

 

History

History
80 lines (57 loc) · 3.44 KB

README.md

File metadata and controls

80 lines (57 loc) · 3.44 KB
Raw

@fecommunity/reactpress

Publish with React. Ship like WordPress.

CMS, Admin, Headless API, Next.js themes, plugins & desktop — one CLI, zero assembly.

npm version npm latest npm downloads License: MIT Node.js

The official ReactPress CLI — install a complete, self-hosted publishing stack in ~60 seconds. CMS API, Web Admin, and Next.js theme support ship together. No Docker, nginx, or external database required for local development.

Layer What you get
CMS API Headless NestJS REST — SQLite locally, MySQL in production
Admin Writing console at /admin/ — posts, pages, media, plugins, themes
Themes npm-installable Next.js frontends — swap without touching content
CLI init, doctor, logs — operate and diagnose from the terminal

Built for frontend teams who want WordPress-grade editing without wiring five repos together.

Documentation · Live demo · Theme demo · GitHub · Chinese overview

Install

# 4.x pre-release (recommended until 4.0.0 stable)
npm install -g @fecommunity/reactpress@beta

# stable (3.x — legacy)
# npm install -g @fecommunity/reactpress

Requires Node.js 20+. On first install, postinstall downloads bundled server runtime dependencies (~1–2 minutes).

Quick start

mkdir my-site && cd my-site
reactpress init
Surface URL
Public site http://localhost:3001
Admin http://localhost:3001/admin/ (admin / admin)
API http://127.0.0.1:3002/api

Run reactpress doctor if something does not start correctly.

Commands

Command Description
reactpress init [dir] Initialize a new publishing site
reactpress doctor [dir] Diagnose Node.js, ports, database, and services
reactpress logs [dir] Tail API logs (error / request / response)
reactpress stop [dir] Stop API and site services

Requirements

  • Node.js 20+
  • macOS / Linux / Windows
  • Embedded SQLite + bundled API (no Docker or MySQL for local dev)

Ecosystem

Package Role
@fecommunity/reactpress-toolkit TypeScript SDK — API clients, theme SSR, plugin hooks
@fecommunity/reactpress-web Admin SPA — static assets and Node mount helpers
@fecommunity/reactpress-server Standalone API (deprecated — use CLI bundled API)

License

MIT © FECommunity

Part of ReactPress — content owned by the system, frontend owned by developers.