@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.64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 556284144cf3a29842a452206b589e78548de17ddaf5f95ad867d98a9d2c5d4b |
|
MD5 | 6daf0def6d15514f0e6173c7854db668 |
|
BLAKE2b-256 | 51aa2d72b30e41a105bd28bc0b9a6ae66a6961a5d10978e0eea8e7019401ee3a |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.64-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d714fdf4bf9d3d0615f1ad60665effff7e72ca994e72dc23a6c7dc6d51c2977e |
|
MD5 | 1bdccc6ddd79788105a6b3d99e6fd881 |
|
BLAKE2b-256 | a43d2731b3c7fcfd93b153503f41392c298655146d36555cf2df02c1fbfc075a |