English (US)
Fork Me on GitHub

这份文档仅适合 SFN 0.5.x 版本,如果想要查阅旧版本 SFN 的文档,请 点击这里

初始化你的项目

创建一个目录以便存储关于你的项目的文件,然后使用这个命令

npm init

来初始化你的项目,假设你已经对 NPM 有了一定的理解并安装了 NodeJS 环境。

准备 TypeScript 环境

SFN 是使用 TypeScript 编写的,因此你也应该 使用它来编写你的代码。

npm i -D typescript
npm i -D @types/node

可选的,你可以安装 ts-node,来实现不编译 源码直接运行。

npm i -D ts-node

安装 PM2(可选)

自 0.3.x 版本起,SFN 使用 PM2 作为其应用管理器和负载均衡器,因此为了使 你的应用更好地部署,你也应当安装 PM2 并使用其来启动你的应用(当然这是生产环境的需求,开发环境中 这并不是必须的)。

npm i -g pm2

安装框架

当你初始化项目完成之后,你现在就可以安装 SFN 框架了,请使用下面的命令:

npm i sfn

在所有文件都下载完成后,输入下面的命令来初始化你的项目,它将会自动地为你创建需要地文件和 目录。

但在你执行这个过程前,你需要设置好环境从而使计算机可以运行用户自定义的 NodeJS 命令行程序。 详情请查看 命令行.

sfn init

启动服务器示例

SFN 提供了一个简单的示例,因此你可以立马开启服务器并观察将会发生什么。

tsc
node dist

如果你希望通过 ts-node 来启动项目,则需要使用下面的命令:

ts-node --files src # --files 参数必须提供

接着,服务器将会在几秒钟之内完成启动。

如果你安装了 PM2,则可以使用下面的命令来启动服务器,并按照 CPU 核心数自动规模化部署:

pm2 start dist/index.js -i max -n my-app