@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.19.34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5f9a0f1c976feb77c203b3de93941ec3fc8d2d5342d61e4a9617bc64cf003fa |
|
MD5 | 8e923c9d7a584246ac6c1bdd947efdf8 |
|
BLAKE2b-256 | 8089e509a74ad1da19f33afd0a195ec1ba4d226ed817c3e30161062dadcbd18f |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dc6b3eb1fb2e340e515fe139c7333b91ab8887a8aedbca69ebb5d32e1137203 |
|
MD5 | dbfb1136da5b61317d96f87ab9980cd6 |
|
BLAKE2b-256 | 60e3349ecaffbed179a147708b9d9825b84c257002cca0d2cd3181d2aeea6b30 |