@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.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c280d790b07a0865e9627f79021da98ef47966655ca5ff00928943a8cc1b6e8 |
|
MD5 | 5e1b4380ac21393f463ad6f2f062ba89 |
|
BLAKE2b-256 | 4e5bd9661e4cce07f77fb25341d26860c8e248c71a36b6faa274b7cc4a5801ef |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9af1bdab9a11feebb2d65b1ab82bd2c7cf7811f2faa9f71d7f3d682dd1ea1859 |
|
MD5 | 586beade8bafe0435c4ce1dacf9412a3 |
|
BLAKE2b-256 | 9ae581e5b3ac149645fb62c347c331f6e9b34a3d811d493790c19d3bb28b38a5 |