nt-cms
nt-cms copied to clipboard
Published
20 hours ago •
notadd
notadd
nest.js with CMS
Notadd CMS
特性
- 现代化管理面板（可选）
- AOP 面向切面编程，基于 Nest.js
- 便于维护，基于 Typescript
- 高性能 【异步IO，单机并发1W+】
- 不限于前端，支持 Vue（推荐Nuxt）、Angular 、React
- 强大的 API： 支持 Graphql
- 优雅的 ORM ： 基于Typeorm
功能
- [x] 文章分类管理
- [x] 文章列表查询
- [x] 文章批量审核
- [x] 文章批量删除
- [x] 页面分类管理
- [x] 页面管理
- [x] 轮播图管理
环境要求：
Nodejs: 8+
数据库： PostgreSQL 9.5+, MariaDB 10.2+, Mysql 5.7+, SQLite, Mongodb, MS SQL Server, Oracle (任意一种)
1分钟安装环境
使用说明
gitclone源码;
-
git clone https://github.com/notadd/nt-cms.git
进入项目目录下安装项目依赖
-
npm install
创建项目需要的数据库并在ormconfig.js文件中配置数据库连接;
postgres:
const SOURCE_PATH = process.env.NODE_ENV === 'development' ? 'packages' : 'src';
module.exports= {
type: 'postgres',
host: 'localhost',
port: 5432,
username: 'postgres',
password: '123456',
database: 'module_test',
entities: ['src/**/**.entity.ts', 'node_modules/**/**.entity.js'],
logger: 'advanced-console',
logging: true,
synchronize: true,
dropSchema: false
}
mysql:
const SOURCE_PATH = process.env.NODE_ENV === 'development' ? 'packages' : 'src';
module.exports= {
type: 'mysql',
host: 'localhost',
port: 3306,
username: 'test',
password: 'test',
database: 'module_test',
entities: [
'src/**/**.entity.ts'
]
logging: true,
synchronize: true
}
sqlite:
const SOURCE_PATH = process.env.NODE_ENV === 'development' ? 'packages' : 'src';
module.exports= {
type: 'sqlite',
database: 'cms_test.db',
storage: 'src/entities/*.entity.ts',
synchronize: true,
entities:[
'src/entities/*.entity.ts'
]
}
配置完成,运行项目
-
npm run start如果没有报错,打开浏览器访问: localhost:3000/graphql
实体定义
-
classify: 文章分类。一个文章分类对应多篇文章。 -
article: 文章。一篇文章对应一个文章分类。不同分类的文章需要输入的内容可能不同,详见信息项。 -
item: 信息项。你可以设置你想要文章展示的项,并将其与文章分类相绑定。这样在添加对应分类的文章时,也需要添加该信息项的值。 -
page-sort: 页面分类。等同于文章分类。 -
page: 页面。页面的作用是控制页面上需要显示的内容,如:页面footer、header、友情链接、联系我们等部分的内容。 -
pictureGroup: 轮播图组。可以设置多组轮播图,使其在不同的页面上展示。
常用接口介绍
文章分类
Mutation:
-
addClassify添加文章分类 -
deleteClassify删除文章分类
Query:
-getAllClassify 获取全部分类结构
-getOneClassify 获取单个文章分类数据
文章
Mutation:
-
createArticle创建文章 -
recycleArticleByIds批量将文章放入回收站 -
auditArticle批量审核文章
Query:
-
getAllArticle根据条件分页搜索文章 -
getRecycleArticle根据条件搜索回收站文章 -
getArticleById通过id获取文章详情
信息项
Mutation:
-
createItem创建信息项 -
deleteItem删除信息项
Query:
-
getAllItem获取所有信息项 -
getOneItem通过id获取信息项详情
轮播图
Query:
-
findpG通过id查看图片组信息
Mutation:
-
addPicGroup新增图片组 -
addPicture新增图片组的图片
tips:系统已自动创建一个根分类,所以用户在创建顶级分类时"上级分类"应传'root',即:
mutation{
addClassify(classify:{
label:"分类1",
value:"classify_1",
parent:{value:"root"}
})
{
code
message
}
}
项目结构
.
├── ormconfig.js 数据库配置
├── src
│ ├── cms.module.ts cms模块配置
│ ├── entities 实体对象
│ ├── graphqls graphql接口
│ ├── interceptors 拦截器
│ ├── interfaces 接口定义
│ ├── resolvers resolver层
│ └── services 方法实现层
└── starter
├── app.module.ts 根模块
└── main.ts 程序入口文件
环境安装
install
安装Node.js
Windows
- 点击下载 Node.js
- 安装Node.js
Powershell/CMD 可以打印出这个说明安装成功。（部分系统需要重启后环境变量才生效）
>> node -v
v10.15.1
>> npm -v
6.4
Ubuntu/Debian （支持ARM及X86平台）
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
（如果安装缓慢，可以使用国内镜像源） 终端可以打出以下信息说明安装成功：
$ node -v
v10.15.1
$ npm -v
6.4
Centos/Redhat/Fedora （支持X86平台）
curl -sL https://rpm.nodesource.com/setup_10.x | bash -
（如果安装缓慢，可以使用国内镜像源） 终端可以打出以下信息说明安装成功：
$ node -v
v10.15.1
$ npm -v
6.4
使用 NVM 安装（支持 所有 Linux 及 Raspbian ，支持多版本管理）
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
如果没 curl ，可以使用 wget 安装
wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
使用 NVM 安装nodejs ：
nvm install --lts
终端可以打出以下信息说明安装成功：
$ node -v
v10.15.1
$ npm -v
6.4
使用 snap 安装（支持 所有 Linux ）
sudo snap install node --classic --channel=10
（如果提示 snap 不存在，请先安装 snapd） 终端可以打出以下信息说明安装成功：
$ node -v
v10.15.1
$ npm -v
6.4
安装数据库
Postgresql （推荐）
Windows 和 Mac 用户 点击下载安装包
Linux 用户使用 apt/yum 等直接安装:
apt install postgresql
或者使用 snap :
snap install postgresql10
如果要开外部访问，以及其他配置，请参考 postgresql配置
notadd