@555platform/portal-components 中文文档教程

Question

portal-components

跨门户共享的组件库

Project Status

Contributing

需要节点 v10+

Installation

此项目包含多个子项目。 您可以通过运行 npm run install_all 为所有嵌套项目安装依赖项。 这将安装所有必要的依赖项，并将 lib 文件夹中的项目链接 到演示项目中。

git clone git@github.com:555platform/portal-components.git
nvm use 8.11
npm run install_all

Creat a demo/server/.env with the following settings (environment dependent)

CLIENT_ID=<INSERT>
CLIENT_SECRET=<INSERT>
DOMAIN=pop.service.srv
REDIRECT_URI=http://localhost:4044/auth/iris/callback
AUTH_SERVER=http://localhost:4655
EKSURL=http://localhost:3007
PORT=4044
LOGIN_SUCCESS=http://localhost:4050/dashboard
LOGIN_FAILURE=http://localhost:4050/
JWT_PUBLIC_KEY=<INSERT>
LOG_FOLDER=logs
LOG_ROTATION_POLICY="YYYY-MM-DD"
SERVER_NAME=localhost:4044
DATABASE_URIS="localhost:27017"
DATABASE_NAME=identities
DB_USER=""
DB_PASSWORD=""
DATABASE_REPLSET=""

创建一个 demo/client/.env.development.local with the following settings (environment dependent)

REACT_APP_CLIENT_ID=<INSERT>
REACT_APP_DOMAIN=pop.service.srv
REACT_APP_REDIRECT_URI=http://localhost:4044/auth/iris/callback
REACT_APP_AUTH_SERVER=http://localhost:4655

Workflow (Standalone)

1. Update files in lib/server and/or lib/client.
2. Build your changes

# from the root of the `portal-components` project
npm run build

3. Run the demo application

# from the root of the `portal-components` project
npm start

注意：实时重新加载仅为演示应用程序代码设置。 demo/ 下的文件更改应立即生效，但是 lib/ 下的任何代码更改都需要重建。 每当您更改 lib 代码时，请务必从项目的根目录运行 npm run build！

Workflow (Portal integration)

当您准备好将您的组件与其中一个门户集成时：

1. Link portal-components

# from the root of the `portal-components` project
npm link

2. Build any changes
   1. Manual build sh # from the root of the `portal-components` project npm run build
   2. Automatic rebuild sh # from the root of the `portal-components` project npm run watch
3. From a local clone of either pop or developer-portal, link portal-components as a dependency

# from the root of either pop or developer-portal
npm link portal-components
cd client
npm link portal-components

4. You can now import your common code e.g import { client as clientCommon } from 'portal-components'.