An open API service indexing awesome lists of open source software.

https://github.com/surmon-china/nodepress

🟢 A RESTful API service for https://surmon.me blog, built with @nestjs.
https://github.com/surmon-china/nodepress

blog blog-api blog-engine cms cms-framework express jwt-token mongodb mongoose nestjs nestjs-blog nestjs-cms nestjs-webhook nodejs nodejs-blog nodejs-cms nodejs-typescript nodepress restful-api typescript

Last synced: 3 months ago
JSON representation

🟢 A RESTful API service for https://surmon.me blog, built with @nestjs.

Awesome Lists containing this project

README

          




nodepress Logo

# NodePress

[![nodepress](https://raw.githubusercontent.com/surmon-china/nodepress/main/branding/badge.svg)](https://github.com/surmon-china/nodepress)
 
[![GitHub stars](https://img.shields.io/github/stars/surmon-china/nodepress.svg?style=for-the-badge)](https://github.com/surmon-china/nodepress/stargazers)
 
[![GitHub issues](https://img.shields.io/github/issues-raw/surmon-china/nodepress.svg?style=for-the-badge)](https://github.com/surmon-china/nodepress/issues)
 
[![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m791570584-8027b44860687b0ac0af7b4c?style=for-the-badge)](https://stats.uptimerobot.com/Q2k7OTXxJN/791570584)
 
[![GitHub license](https://img.shields.io/github/license/surmon-china/nodepress.svg?style=for-the-badge)](/LICENSE)

**A RESTful API service for [surmon.me](https://github.com/surmon-china/surmon.me) blog, built with [NestJS](https://github.com/nestjs/nest), required [MongoDB](https://www.mongodb.com/) and [Redis](https://redis.io/).**

适用于 [surmon.me](https://github.com/surmon-china/surmon.me) 的 RESTful API 服务端应用;基于 [NestJS](https://github.com/nestjs/nest) 开发,需安装 [MongoDB](https://www.mongodb.com/) 和 [Redis](https://redis.io/) 方可完整运行。

- [Architecture](/ARCHITECTURE.md) | [中文架构文档](/ARCHITECTURE.zh-CN.md)
- [API Documentation](https://github.surmon.me/nodepress)
- [Changelog](/CHANGELOG.md#changelog)

**Related projects:**

- **SSR blog:** [`surmon.me`](https://github.com/surmon-china/surmon.me) built with Vue.
- **Blog AI Agent:** [`surmon.me.ai`](https://github.com/surmon-china/surmon.me.ai) built on Cloudflare.
- **Blog admin site:** [`surmon.me.admin`](https://github.com/surmon-china/surmon.me.admin) built with React and [Veact](https://github.com/veactjs/veact).
- **Blog native app:** [`surmon.me.native`](https://github.com/surmon-china/surmon.me.native) built with React Native.

---

### Development

```bash
$ pnpm install

# dev
$ pnpm run start:dev

# test
$ pnpm run lint
$ pnpm run test
$ pnpm run test:watch
$ pnpm run test:cov

# build
$ pnpm run build

# run
$ pnpm run start:prod
```

### Actions

- Any PR open → `CI:Build test`
- New tag `v*` → `CI:Create release`
- Release created → `CI:Deploy` → `CI:Execute server deploy script`

### TODO

- About ES Modules support [#13319](https://github.com/nestjs/nest/issues/13319) / [#13817](https://github.com/nestjs/nest/issues/13817)

### Changelog

Detailed changes for each release are documented in the [release notes](/CHANGELOG.md).

### License

Licensed under the [MIT](/LICENSE) License.