@aws-prototyping-sdk/cloudscape-react-ts-website
Project description
Getting started
To create a new Cloudscape React Typescript Project, there are a couple of options:
Via Projen CLI
npx projen new --from @aws-prototyping-sdk/cloudscape-react-ts-website cloudscape-react-ts-website [--application-name <your-app>]
Programmatically
new CloudscapeReactTsWebsiteProject({
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.cloudscape_react_ts_website-0.11.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf8c6ae289695b13ba1948838008d0c2730a8d1a2ae6f3468e428c3133cdc83a |
|
MD5 | 8dd259c615c8f2e4b2fbddc7146e6a19 |
|
BLAKE2b-256 | fb60b8361d0304380511a560610b0051bdb827a91844ef64d8095b2b82605d15 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.11.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a22f140bff928a75632985ec6e44894506ca61fd8607e6cbfc7c0c3203255c3 |
|
MD5 | 4f9419a36a2dad3bc3ed8415d2950e4f |
|
BLAKE2b-256 | c79d4224be1036154f4980892119540235992ba88b163fd19b4c26c0c9061b18 |