@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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 164c2fae8098c749a4ec71cbf832af3dd31a83b493923a898cfdb5d877c745d9 |
|
MD5 | 2837c67dd625163a53551077fc7f58d3 |
|
BLAKE2b-256 | a961a5c436cdb832ddc1e6b8f929a29565afada91539796d8b8f7ea3e3531dc0 |
Hashes for aws_prototyping_sdk.awsui_react_ts_website-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2fc5b19c08c55a7678d9bd2143b7a3064f293184561de731850172ccb2294ae |
|
MD5 | 27029ba09e45ebc96f9079541df7afbb |
|
BLAKE2b-256 | 9e6bd18e9a1dc05d6960217600ee1da86e0568a71fee20cb7c72b385ac9c1973 |