Rester

Rester Framework 是一个使用 TypeScript 语言，类似于 Koa 且支持 TSX 语法的后端服务的框架，可用于快速搭建 RESTful API。

Rester Framework is based on TypeScript, be similar to Koa and support TSX syntax, makes it easy to build RESTful APIs.

推荐使用 NX 来创建 Rester 项目，见 @rester/nx 文档。

Recomend to use NX to create Rester project, see @rester/nx Documents。

1 快速入门 / Quick Start

1.1 搭建项目 / Create Project

# 1 Create a nx workspace
pnpm dlx create-nx-workspace
# 2 Add @rester/nx to your package.json
pnpm add -D @rester/nx@latest
# 3 Create a Rester App in your nx workspace
pnpm nx generate @rester/nx:application --name=app-name
# or shortcut
# nx g @rester/nx:app --name=app-name

Rester App 的代码位于 apps/app-name 目录下。

1.2 启动项目 / Bootsratp Project

pnpm nx serve app-name

现在，访问 http://localhost:8080/aphorisms 即可查看项目，或运行 pnpm nx test app-name 来执行测试。

作者 / Author

IInfinity 夜寒苏, 电子邮箱 / Email, GitHub, 夜寒苏的窗台 / Blog.

开源许可 / License

THE MIT LICENSE for code.

Copyright IInfinity © 2018+

LICENSE: MIT

Click https://raw.githubusercontent.com/DevinDon/license/master/THE%20MIT%20LICENSE to view a copy of this license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THE CC-BY-NC-4.0 LICENSE

Copyright © 2018+ Devin Don

LICENSE: CC BY-NC 4.0

Click https://raw.githubusercontent.com/DevinDon/license/master/THE%20CC%20BY-NC%204.0%20LICENSE to view a copy of this license.

This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.

To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/

or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.