[翻译] Synth 官方教程1 - 一个专注于RESTful和SPA的Node Web框架

*此教程翻译现已PR同步到了此框架官网,请戳 ->Synth 教程

简介

看完这篇教程后,你就会知道如何给用 Synth 创建的默认应用添加功能了。

教程中的示例应用只是一个非常简陋的Twitter,简陋到只具有推文列表的显示功能(但我们会在后面慢慢为它添加功能)。

此教程将会指导你完成:

  1. 安装 Synth
  2. 创建你的第一个项目。

然后我们将会为这个应用添加以下这些功能:

  1. 能够发布新推文;
  2. 能够链接到某条推文单独的页面;
  3. 能够以非匿名状态发送推文。

创建

依赖关系

在开始使用 synth 之前,你需要安装下面这些库以保证能够正常使用 synth

  • Node 版本0.10.0及以上 - 免费获取
  • NPM 版本1.3及以上(现在它应该会在安装Node的时候一起被安装)
  • MongoDB - 免费获取 - 安装完成之后别忘记在后台启动好它

安装 Synth

我们可以通过NPM去获取 synth 。将它安装在全局环境中以便我们能通过命令行进行调用:

npm install -g synth

备注:当你执行上述代码的时候,如果收到了权限错误之类的提示,你可能需要使用 sudo npm install -g synth 来进行安装。

创建一个新的应用

synth new my_app

这条命令会把新应用创建到 my_app 文件夹中,当然你也可以将它换成任何你喜欢的名字。

cd my_app # 切换到你新应用的根目录中
synth install -b # 安装第三方的后端库(通过npm)
synth install -f # 安装第三方的前端库(通过bower)

然后进入应用文件夹并安装你需要的第三方前端库和后端库*[译注:由于这两个命令分别是基于npm和bower的,所以依赖库的配置文件都会使用它们各自的文件,分别是 back/package.jsonfront/bower.json]*。

尽管你已经将 synth 装在了全局环境中,但为了能够在命令行中使用它,我们还需要在项目中安装它。执行 synth install -b 来安装它*[译注:这时候它去查找的其实就是 back/package.json 中的依赖关系,在使用 synth 生成应用的时候它就默认把自己也给放进这个依赖关系中了]*。

备注

  • 后端依赖库将会安装在 my_app/back/node_modules 文件夹中。
  • 前端依赖库将会安装在 my_app/front/bower_components 文件夹中。

运行这个应用

执行 synth server 或者 synth s 就可以启动这个应用了。

若要以生产模式(即所有的源文件都被压缩及合并)运行这个应用,需要将 NODE_ENV 这个环境变量设置为“production”,然后执行 synth server [译注:在启动服务器命令的前面加上 NODE_ENV=production 来将环境变量改变],或者直接执行 synth prod 命令*[译注:执行这个命令就等同于将环境变量设置为 production 之后再执行 synth server ]*。

你可以通过 -p 传递 PORT 参数来设置服务器的监听端口,例如: synth s -p 3001。3000 是 synth 的默认监听端口。

预配置数据库

当你将浏览器地址指向 http://localhost:3000/tweets/ 的时候,应该能够在页面中间看见“Tweets”这个标题了。但是传说中的 "tweets"(推文) 在哪里呢?

不用担心,synth 已经帮你创建了一个能够自动向数据库添加一些推文的脚本。

再打开一个终端窗口,运行这个脚本来生成推文:

node back/generateTweets.js

等它执行完毕后刷新这个应用,应该就能看到20条推文被显示出来了。

原文地址:

  1. https://www.synthjs.com/tutorial/#intro
  2. https://www.synthjs.com/tutorial/#setup