https://github.com/ymm-tech/gods-pen-server
码良服务端项目
https://github.com/ymm-tech/gods-pen-server
Last synced: about 1 year ago
JSON representation
码良服务端项目
- Host: GitHub
- URL: https://github.com/ymm-tech/gods-pen-server
- Owner: ymm-tech
- License: mit
- Created: 2019-10-31T08:54:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-20T21:31:16.000Z (about 3 years ago)
- Last Synced: 2025-03-31T18:21:13.351Z (about 1 year ago)
- Language: JavaScript
- Size: 563 KB
- Stars: 180
- Watchers: 9
- Forks: 118
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - ymm-tech/gods-pen-server - 码良服务端项目 (JavaScript)
README
# 码良服务端
## :house: 官网
官网： https://godspen.ymm56.com/
使用手册： https://godspen.ymm56.com/doc/cookbook/introduce.html
在线体验： https://godspen.ymm56.com/admin/#/home
私有部署： https://godspen.ymm56.com/doc/cookbook/install.html
:point_right: `喜欢别忘了加star支持我们，你的支持是我们坚持的动力` :point_left:
## 项目构成
码良系统由3个项目构成，分别是 [gods-pen-server](https://github.com/ymm-tech/gods-pen-server) 码良服务端、
[gods-pen-admin](https://github.com/ymm-tech/gods-pen-admin)
码良管理后台以及于7月份就已经开源的 [gods-pen](https://github.com/ymm-tech/gods-pen) 码良编辑器。
## 详细部署文档
https://godspen.ymm56.com/doc/cookbook/source.html
## 配置说明
码良依赖 es、redis、mysql、邮件、oss服务，因此需要配置这些服务的信息
config/ 文件夹下存放了开发配置和生产配置
### 前期准备
除过 mysql 以外，其他服务都开箱即可使用，无需进行初始化之类的操作
**mysql 需要使用 sql/init.sql 来初始化表结构和表数据**
### 开发配置
本地开发时，使用的是配置文件为 config/config.dev.js
### 生成配置
服务器部署时，使用的是配置文件为 config/config.production.js
## 开发
开发
```bash
npm run dev
```
debug(在vscode中端点调试)
```bash
npm run debug
```
## 部署
启动服务
```bash
npm run serve
```
终止服务
```bash
npm run stop
```
查看日志
```bash
tail $HOME/logs/master-stdout.log -n 500 -f # stdout
tail $HOME/logs/master-stderr.log -n 500 -f # stderr
```