journey-to-the-west 西游记

西游记是一款网页联机式的纸牌类游戏，该项目是西游记的后端部分。前端部分请参考 https://github.com/shurintou/journey-to-the-west。

该指南假设你已完成前端项目的启动。

开发环境

安装数据库

该项目的持久化框架使用了 Sequelize,所以你可以使用 Postgres, MySQL, MariaDB, SQLite 以及 Microsoft SQL Server中任意一种数据库系统来持久化保存数据。

该项目默认使用的是MySQL(建议版本>5.7)，下载地址

将MySQL安装好后请修改config-development.js中mysql的相应配置，并启动MySQL。

如果需要注册的邀请码，可在该项目成功启动后，在通过Sequelize框架自动生成的数据库表invitationCode中自行增加。

安装Redis

该项目使用Redis缓存用户session，游戏数据，排行榜等数据。

该项目使用的版本是Redis 5.0.10, 下载地址

将MySQL安装好后请修改config-development.js中redis的相应配置，并启动Redis。

安装依赖

在项目根目录下输入下列指令以安装项目依赖。

npm install

启动项目

打开配置文件config-development.js，将其中的port, frontOrigin和APIRoot的对应字段改为与你的前端配置对应的内容。 改好后输入以下命令启动项目。

npm run dev

之后便可以在本地提供接口给前端项目了。

生产环境

生产环境下的后端项目部署与开发环境大同小异，其中安装数据库与Redis可参考开发环境的说明。

然后将前端项目打包好的dist文件夹放到该项目的根目录下。

安装依赖

在项目根目录下输入下列指令以安装项目依赖。

npm install

启动项目

在/config目录下创建config-production.local.js,如无特别需求可直接复制粘贴config-development.js中的内容，但须将其中的port, frontOrigin和APIRoot的对应字段改为与你的前端配置对应的内容。 改好后输入以下命令启动项目。

npm run start

注意：生产环境下项目的访问路径与开发环境稍有不同，请在后端项目的域名 + 后端项目的端口下访问。