@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.50.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d9dd5eb0a437db35f23c05a88aa8be5736454f9f554de80bd4cef253f7f31da |
|
MD5 | 0c0f507dfb549d5efe29075ebc06e4f3 |
|
BLAKE2b-256 | c5ac972c42843f060c0fdee69a7262af12d0d40f8c339409d2a0a15a1e5ed97c |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.50-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 311826cbea75b7a1d32695382e1dacbee7667dd403ca10f2e7a0f536bd648a0b |
|
MD5 | db0e3a0d94cda824baa7b72543806d69 |
|
BLAKE2b-256 | 052eec6fd1c8cc2ebc7cd1de0b86be1b1d0aec21aca2a99e2c75f8fd4b63a668 |