创建项目

创建Steedos项目前,请先 安装开发环境

创建Steedos项目

创建新项目

创建一个名为test的新项目

yarn create steedos-app test

安装依赖包

cd test
yarn

查看文件夹结构

项目创建后,您的项目文件夹内容如图如下:

文件夹结构

其中

  • 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包。

运行Steedos项目

启动服务

终端执行以下代码:

yarn start

停止服务

如果要停止项目,在终端上同时按住键盘上的Ctrl + C,

终止批处理操作吗(Y/N)? y

输入y即停止服务。

进入系统,创建企业并使用

服务启动后,即可使用浏览器访问用户界面,访问地址默认为 http://127.0.0.1:5000/ 。如果已修改环境变量,则为 .env.local / .env 中的ROOT_URL 。

登录页

上方显示“邮件服务未配置,点击查看帮助”,点击可查看如何通过配置开通发邮件功能。可参考 steedos-config

注册一个账户

第一次使用本项目时,数据库为空。您需要点击“注册”,用邮箱注册一个新账户。

登录页

输入邮件

输入验证码

如果已开通发邮件功能,可到邮箱中取验证码;如果尚未配置,则到终端上取验证码:

注册

输入验证码

创建一个企业

填写姓名后,输入企业名称,

创建企业

创建完毕

即可完成企业的创建。

点击“首页”即可进入系统主页面。

浏览系统主页面

PC界面展示

移动端界面展示

要进入系统,可以通过验证码登陆。也可以给账户设置密码。

设置登录密码

在设置 > 个人账户设置 > 我的资料 中,可以更改密码。

设置密码

更多的系统设置及使用,请参考 如何设置组织如何设置审批如何使用审批

教程源码及下载运行

本教程的系列代码在 steedos-lesson-contracts 项目下,我们已将代码开源,供您下载运行,及做参考。本教程为 教程1、创建项目

下载源码

请在 steedos-lesson-contracts 页面,点击“Clone or download”,并选择“Open in Desktop”,即可在GitHub Desktop中clone这个项目到本地文件夹。

clone源码

安装依赖包

源码clone到本地文件夹后,在终端执行以下代码:

# 进入实际的本地文件夹
cd d:\github\steedos-lesson-contracts
cd lesson1
yarn

启动教程1项目

yarn完成后,继续执行:

yarn start

使用教程1项目

在浏览器中,访问地址 http://127.0.0.1:5000/ ,即可访问本项目的前台页面。

停止教程1项目

如果要停止项目,在终端上同时按住键盘上的Ctrl + C,

终止批处理操作吗(Y/N)? y

输入y即停止服务。