@aws-prototyping-sdk/awsui-react-ts-website
Project description
Getting started
To create a new AWS UI React Typescript Project, there are a couple of options:
Via Projen CLI
npx projen --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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws_prototyping_sdk.awsui_react_ts_website-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22e09a44ea045b239a7f4b8680c51fa86d54a77c28d5393fb7f2d1f7fc478999 |
|
MD5 | 199afcc3f15aefcc7518c511b3fe750f |
|
BLAKE2b-256 | fecf52eae36da06fbeefbfd8f3e78d0ca6c853ec7be2d992782ece0af6de0990 |
Hashes for aws_prototyping_sdk.awsui_react_ts_website-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d0ad04eb9c0a916935b2a04d3414b47906be73d614a2e1967d54575f21a013a |
|
MD5 | de3c102f98fb2534f19e6fc9cb0b8837 |
|
BLAKE2b-256 | e074af209af56745628fcd068383251b3243a9c6b365223455ff23f5e5e3b1d2 |