Getting started
To create a new AWS UI React Typescript Project, there are a couple of options:
Via Projen CLI
npx projen new --from @aws-prototyping-sdk/awsui-react-ts-website awsui-react-ts-website [--application-name <your-app>]
Programmatically
new AwsUiReactTsWebsiteProject({
defaultReleaseBranch: "mainline",
name: "<name-of-package>",
applicationName: "<name-of-app>",
});
Running your synthesized Application
To run your synthesized application locally, run npx projen dev.
Developer Notes
To enable Cognito auth, ensure you have a runtime-config.json file in the root of your deployed project which at least contains the following:
{
"region": "<aws-region>",
"identityPoolId":"<identity-pool-id>",
"userPoolId":"<user-pool-id>",
"userPoolWebClientId":"<user-pool-web-client-id>"
}
The easiest way to get this set up is to use the static-website + identity packages to deploy your website.
An example of how to do this is as follows:
const userIdentity = new UserIdentity(this, 'UserIdentity');
new StaticWebsite(this, 'StaticWebsite', {
websiteContentPath: '<relative>/<path>/<to>/<built>/<website>',
runtimeOptions: {
jsonPayload: {
region: Stack.of(this).region,
identityPoolId: userIdentity.identityPool.identityPoolId,
userPoolId: userIdentity.userPool?.userPoolId,
userPoolWebClientId: userIdentity.userPoolClient?.userPoolClientId,
}
},
});
For local development, you will need to copy the generated runtime-config.json file into your /public directory. An example on how to do this is as follows:
curl https://dxxxxxxxxxx.cloudfront.net/runtime-config.json > public/runtime-config.json
1 maintainer
Metadata
1 maintainer
Release files for aws-prototyping-sdk.awsui-react-ts-website 0.3.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws_prototyping_sdk.awsui_react_ts_website-0.3.14.tar.gz | 75.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_prototyping_sdk.awsui_react_ts_website-0.3.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 150.4 kB
Release files / aws_prototyping_sdk.awsui_react_ts_website-0.3.14.tar.gz
| Download URL | aws_prototyping_sdk.awsui_react_ts_website-0.3.14.tar.gz |
|---|---|
| Size | 75.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f71c98371a13cb8668d3eadd1f69c2c04acf69b02240f0f6eb5c9d21726bbc2b
|
|
BLAKE2b-256 checksum How to use checksums |
9fc0e96261ed034c8597f44dec1e4983c0e90e5ee0fc6227ab798b2a0d2361e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
Release files / aws_prototyping_sdk.awsui_react_ts_website-0.3.14-py3-none-any.whl
| Download URL | aws_prototyping_sdk.awsui_react_ts_website-0.3.14-py3-none-any.whl |
|---|---|
| Size | 74.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e14e26da4c96d7ef26619168e29ec319a036c1dc449cf7697e9702a1d5dbd33b
|
|
BLAKE2b-256 checksum How to use checksums |
5b63cb033a7c5509a41166d2074386c4962759ed42ef6ad2a36a80985d9e06cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
