创建项目
系统要求#
为了更好的使用Steedos DX，请您在开始之前检查是否符合以下要求，如不符请先升级版本，再进行后续操作
- Steedos Platform 1.23 +
- Mongodb 4.2 +
开始第一个项目#
Steedos DX为您提供了不同的选项来创建Steedos DX项目，您可以同时使用喜欢的版本控制系统，如Git，以此来管理团队的开发进程。
| 序号 | 创建方法 | 创建方式 |
|---|---|---|
| 1 | 创建空项目 | 通过命令直接创建Steedos DX项目 |
| 2 | 克隆模版项目 | 使用GitHub上的示例项目来了解Steedos DX的功能 |
| 3 | 通过现有项目创建Steedos DX | 通过将现有的旧项目转换成新格式开始Steedos DX项目开发 |
1、创建空项目#
- 创建名为my-app 的项目
- 切换到my-app项目目录
- 安装依赖
Steedos DX项目具有特定的项目结构和格式，项目创建后，您的项目文件结构如图所示：
2、克隆模版项目#
- 打开终端或命令控制符窗口，这里以Contract Management为例克隆GITHub上的示例项目steedos-app-contract
- 将源码clone到本地文件夹后，在终端或命令控制符窗口执行以下代码，切换目录
- 安装依赖
3、通过现有项目创建Steedos DX#
如果您已经是Steedos开发人员或已经在Steedos上创建了自己的应用程序，您还可以通过项目转化的方式实现现有项目转为Steedos DX项目。
项目结构简介#
项目创建后，您的项目文件夹内容如图如下：
其中
- src: 项目源码
- .env: 环境变量配置文件，可以配置端口、URL等环境变量。
建议修改.env.local中的ROOT_URL，其默认值中的IP为“127.0.0.1”，可改用本机的IP地址。这样，在其他机器就可以用ROOT_URL来访问系统了。 如果是多人协作同一个项目的时候，推荐各自新建 .env.local 来替代 .env 。如果存在文件.env.local 。 系统启动时，就从文件.env.local中读取环境变量。反之，如果不存在文件.env.local，系统启动时，则从文件.env中读取环境变量。
- steedos-config.yml: 项目配置文件，可以配置数据源、插件等参数。
- package.json: 主要用于配置本项目依赖的npm包。
设置环境变量#
.env，用于配置环境变量，位于项目的根目录。
如果是多人协作同一个项目的时候，推荐各自新建 .env.local 来替代 .env 。
如果存在文件.env.local，系统启动时，就从文件.env.local中读取环境变量。反之，如果不存在文件.env.local，系统启动时，则从文件.env中读取环境变量。
默认的环境变量#
项目创建后，默认的环境变量包括：
可按需修改这些环境变量的值。修改后，重启服务即生效。
- MONGO_URL ： MongoDB的连接URL
- PORT ： 系统的端口号
- ROOT_URL ： 系统的访问网址，建议改用本机的IP地址。这样，在其他机器就可以用ROOT_URL来访问系统了。
自定义环境变量#
可以在.env.local / .env 中，按需配置自定义的环境变量。 自定义的环境变量主要服务于steedos-config.yml 。
例如，在.env.local中添加自定义的环境变量
定义环境变量ENV_CFS_STORE=local 后，就可以在steedos-config.yml 里引用它。
升级内核版本#
package.json: 主要用于配置项目依赖的 npm 包，位于项目的根目录。
而升级 steedos-server 版本，可通过修改 package.json 中的 "dependencies" 下的 "steedos-server" 版本号，来更新发包的最新版本。
升级 steedos-server 版本#
例如： "steedos-server" 从 "1.21.0" 更改为最新版本 "1.21.8" 后，保存 package.json 文件，并在终端执行 yarn 安装相关依赖包后，继续执行：
成功重启服务，即完成升级 steedos-server 版本。
项目运行#
启动服务#
终端执行以下代码：
停止服务#
如果要停止项目，在终端上同时按住键盘上的Ctrl + C，输入y即停止服务。
