Skip to content

Commit f6e82eb

Browse files
authored
Update README with upcoming change warning (#302)
1 parent 5213739 commit f6e82eb

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,37 @@
11
<p align="center"><img width=60% src="docs/media/ReactSDK-Logo.png">
22

3-
# React SDK
3+
<hr />
4+
<h1 style="color: red">IMPORTANT – PLEASE READ!</h1>
5+
6+
<h3>On <strong>April 24, 2023</strong>, there will be a <strong>significant update</strong> to the React SDK <strong>main</strong> branch.</h3>
7+
<br />
8+
9+
**We strongly recommend that existing SDK users** clone the update into a new working folder locally. The existing SDK folder structure has significantly changed and may result in the deletion of folders in your local working copy. Some recommendations on how to migrate your existing components to the new SDK will be published on the release date, along with a comprehensive set of documentation updates describing the new capabilities (navigate to **https://docs.pega.com** and then search for 'Constellation SDKs').
10+
11+
**For any SDK user who wants to remain on the old main branch**, check out the following branch which will be created on April 24, 2023 before updates are made to the **main** branch:
12+
13+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**release/8.8.10**
14+
15+
The updates that will be made to the main branch reflect a significant repackaging of the React SDK that addresses 2 key improvements:
16+
17+
1. The **DX Component Builder tool** for creating custom DX components is **fully integrated** into the SDK. There is no longer a need to create custom components with a separate tool (in a separate folder structure) and then copy the components into the SDK.
18+
19+
2. The Pega-provided React SDK components have been moved into an npm package (@pega/react-sdk-components) that is a new dependency for the React SDK. This means that a new React SDK project provides an **empty component structure** that will only contain the SDK user’s code without the clutter of the Pega provided components. SDK users will add their components to the project by creating custom components or overriding existing Pega components. It also allows for easier updates to the Pega-provided components since updates to the npm package won’t directly affect the SDK user’s code.
20+
21+
A new repo (from which the @pega/react-sdk-components and @pega/react-sdk-overrides packages are created) will be public and open source soon. When it becomes public, the source code for the React SDK components will be available there. Until then, the source code for the components
22+
can be found in the node_modules/@pega/react-sdk-overrides/lib directory.
23+
24+
<hr />
25+
26+
<h1> React SDK</h1>
427

528
The **React SDK** provides Pega customers with the ability to build DX components that connect Pega’s ConstellationJS Engine APIs with a design system other than Pega Cosmos.
629

730
The React SDK differs from out-of-the-box Constellation design system because it provides and demonstrates the use of a React design system that is not the Pega **Constellation** design system. The alternative design system used in this React SDK is **Material UI** (https://mui.com/).
831

932
The React SDK is built on a new and modernized UI technology stack (the Constellation JavaScript Engine and Constellation JavaScript API). Many additional SDK features are planned for 1H 2022 to expand the scope of supported use cases.
1033

34+
<br />
1135

1236
<br>
1337

@@ -21,7 +45,7 @@ The **MediaCo** sample application is already configured as a Constellation appl
2145

2246
The **React SDK** has been tested with:
2347
- node 18.12.1/18.13.0
24-
- npm 8.19.2/8.19.3
48+
- npm 8.19.2/8.19.3
2549

2650
Future updates to the SDK will support more recent LTS versions of node as Constellation supports them.
2751

@@ -236,8 +260,8 @@ You can test both **Portal** and **Embedded** scenarios by executing the followi
236260
<br>
237261
238262
### Check Node/NPM versions
239-
Currently, the SDK supports Node 18.* (LTS/Hydrogen) and has been tested with node 18.12.1/18.13.0 and npm 8.19.2/8.19.3, respectively.
240-
Future updates to the SDK will support more recent LTS versions of node as Constellation supports them.
263+
Currently, the SDK supports Node 18.* (LTS/Hydrogen) and has been tested with node 18.12.1/18.13.0 and npm 8.19.2/8.19.3, respectively.
264+
Future updates to the SDK will support more recent LTS versions of node as Constellation supports them.
241265
242266
### Verify/update Cross Origin Resource Sharing (CORS) Infinity record
243267

0 commit comments

Comments
 (0)