Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vellengs/typerx
A lightweight typescript annotation rest based extra (express、 mongoose、 angular、zorro、ng-alain ...).
https://github.com/vellengs/typerx
cms express fullstack mongodb ng-alain ng-zorro-antd rest swagger typescript
Last synced: about 2 months ago
JSON representation
A lightweight typescript annotation rest based extra (express、 mongoose、 angular、zorro、ng-alain ...).
- Host: GitHub
- URL: https://github.com/vellengs/typerx
- Owner: vellengs
- License: mit
- Created: 2017-11-11T00:08:03.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T06:20:09.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T02:53:01.185Z (9 months ago)
- Topics: cms, express, fullstack, mongodb, ng-alain, ng-zorro-antd, rest, swagger, typescript
- Language: JavaScript
- Homepage: http://typerx.top
- Size: 16.4 MB
- Stars: 77
- Watchers: 4
- Forks: 18
- Open Issues: 60
-
Metadata Files:
- Readme: README-zh_CN.md
- License: LICENSE
Awesome Lists containing this project
README
# typerx
一个轻量基于 typescript 注解接口的可延伸扩展的系统, 专注于自动的接口维护, 让前后端开发平滑无隙。
[English README](README.md)
# 项目缘由
近年来前端技术的野蛮发展，虽然促进了前端岗位的专业化，但逐渐的前后端的割裂也越发明显，这种沟隙不仅在后端产生也包括的系统的设计者。
如何填补好前端、后端以及系统设计者之间的鸿沟， 这便是typerx 努力的方向。
- typerx 希望帮助前端适当延展到后端, 主要是掌握接口标准化，能模拟后端接口，或者简单实现小型系统后端。
- typerx 希望帮助后端延展到前端，对于非高交互类（无需定制复杂组件，或者基础组件）使用现成的组件、页面复用进行系统生产。
- typerx 希望帮助设计人员，更好的迭代系统设计，保持模型、接口、代码以及文档的同步更新，更好的进行团队交流。
# 项目特色
- 项目采用 swagger 作为前后端的沟通桥梁, 由代码自动生成 swagger 标准接口文档, 然后生成前端接口模块，从而降低前后端调试难度。
[巧用 Swagger 在线编辑器生成前端接口代码](https://juejin.im/post/5b3849c2f265da597901e9da)
- 项目大量使用 json-schema-form 动态表单简化 CURD 页面复杂度, 这样通用的页面可以快速完成。
[动态表单 json-schema-form 的使用](https://ng-alain.com/form/getting-started)
- 项目前端采用 ng-zorro 组件库、ng-alain 脚手架完成前端界面。
[https://ng-alain.com/](https://ng-alain.com/)
- 服务端采用 express、typescript 注解方式完成, 代码工整清晰。
[Nodejs 下用mongodb 怎么写出 c# 的感觉](https://juejin.im/post/5b18eec7e51d4506825f13b5)
# 功能模块
### 系统管理
- 设置管理
- 帐号管理
- 菜单管理
- 角色管理
- 字典管理
- 日志管理
### 简单的 CMS 模块
- 页面管理
- 文章管理
- 分类管理
- 媒体管理
- 小部件管理
# 项目演示
[typerx 演示](http://typerx.top)
使用 admin:888888 登录
### 快速开始
```bash
# clone our repo
# --depth 1 removes all but one .git commit history
$ git clone --depth 1 https://github.com/vellengs/typerx.git
# change directory to our repo
$ cd typerx
# import system default data
$ npm run import
# install the repo with npm
$ npm install
# start the server
$ npm start
```
### 测试
```
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
### 使用的技术栈
#### angular >= 5;
[angular](https://github.com/angular/angular)
#### ant design angular version zorro
[ng-zorro](https://github.com/NG-ZORRO/ng-zorro-antd)
#### ng-zorro-antd admin panel front-end framework
[ng-alain](https://github.com/cipchk/ng-alain)