Skip to content

Commit 44a3614

Browse files
committed
Added description and badges into the readme file
1 parent fd9612e commit 44a3614

1 file changed

Lines changed: 52 additions & 4 deletions

File tree

README.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,61 @@
1-
# NextPress Technical Specification
1+
<div align="center">
22

3-
**A WordPress-like CMS built with Next.js, TypeScript, PostgreSQL, and Prisma.**
3+
# NextPress
44

5-
NextPress replicates the flexibility of WordPress (custom content types, plugins, themes, blocks) on a modern stack with type safety, server-side rendering, and an API-first architecture.
5+
**The modern, open-source CMS for the Next.js ecosystem.**
66

7-
Current state: 244 TypeScript files, 18,752 lines of code, 28 Prisma models, 11 tRPC routers, 11 service modules, 13 test files.
7+
[![CI](https://github.com/nextpress/nextpress/actions/workflows/ci.yml/badge.svg)](https://github.com/nextpress/nextpress/actions/workflows/ci.yml)
8+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
9+
[![Next.js](https://img.shields.io/badge/Next.js-14+-000000?logo=nextdotjs&logoColor=white)](https://nextjs.org/)
10+
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-4169E1?logo=postgresql&logoColor=white)](https://www.postgresql.org/)
11+
[![Prisma](https://img.shields.io/badge/Prisma-ORM-2D3748?logo=prisma&logoColor=white)](https://www.prisma.io/)
12+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
13+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
14+
[![Coverage](https://img.shields.io/badge/Coverage-Unit%20%7C%20Integration%20%7C%20E2E-blue)]()
15+
[![Code Style](https://img.shields.io/badge/Code_Style-Prettier-ff69b4?logo=prettier&logoColor=white)](https://prettier.io/)
16+
17+
WordPress taught the world that anyone can publish on the web. NextPress carries that mission forward with a modern foundation: **type-safe TypeScript**, **server-rendered React**, **structured block content**, and an **API-first architecture** that works for both traditional websites and headless frontends.
18+
19+
</div>
20+
21+
---
22+
23+
### What is NextPress?
24+
25+
NextPress is a content management system that gives you the flexibility of WordPress — custom content types, a plugin ecosystem, swappable themes, a block-based editor, media management, editorial workflows, SEO, comments, menus, and multi-site — built entirely on Next.js, TypeScript, PostgreSQL, and Prisma.
26+
27+
It is designed for developers who want to build content-driven websites and applications without sacrificing type safety, performance, or the ability to extend every part of the system.
28+
29+
### Why not just use WordPress?
30+
31+
WordPress is PHP, relies on a 20-year-old architecture, has no type safety, mixes rendering with data access, and doesn't support modern deployment targets (serverless, edge, containers) without significant friction. NextPress solves these problems while preserving what WordPress got right: the content model, the plugin/theme ecosystem pattern, and the editorial experience.
32+
33+
### Why not a headless CMS (Sanity, Strapi, Contentful)?
34+
35+
Headless CMSs separate the backend from the frontend, which adds latency, deployment complexity, and a disconnect between content editing and content rendering. NextPress keeps them in one repository — the admin panel and the public site share the same process, the same types, and the same cache. Publish a post and the public page updates in under a second, not after a webhook round-trip.
36+
37+
### Project Status
38+
39+
NextPress is in **active development**. The architecture is complete and the core systems are implemented:
40+
41+
| Metric | Value |
42+
|--------|-------|
43+
| TypeScript files | 244 |
44+
| Lines of code | 18,752 |
45+
| Prisma models | 28 |
46+
| tRPC routers | 11 |
47+
| Service modules | 11 |
48+
| Block types | 6 |
49+
| Test files | 13 |
50+
| Permissions | 28 |
51+
| Hook events | 16 |
52+
53+
The next step is wiring the monorepo dependencies (`pnpm install`), running the first migration, and booting the dev server. See [Getting Started](#23-getting-started).
854

955
---
1056

57+
# Technical Specification
58+
1159
## Table of Contents
1260

1361
1. [Architecture](#1-architecture)

0 commit comments

Comments
 (0)