@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 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
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.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55a8c35da60d470ca40ebe65409c270487ab3194cfa7b6d50eb6a2ff210d4102 |
|
MD5 | 0ea4c8b7907f9d17326defa9ba6d8ba8 |
|
BLAKE2b-256 | 7cbaaba3fd73b5ad6fe4955fd00b6f6b48091bad0d0abb78df87ccf251f596d2 |
Hashes for aws_prototyping_sdk.awsui_react_ts_website-0.2.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e78c9c7b4d7a3e9864720b524004df904cfb86584f63ad77a685f3ba5f04f2a |
|
MD5 | 85ca252fcd2057cf52b3abbaa9be5dc9 |
|
BLAKE2b-256 | 1c9a32decba3b4dbe4ed80c2ed8e5fcad181986ab0e872641f109055f8b6c3d8 |