@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.12.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 144cefff6c4dd8041136217c2d392a54519cad177df7aff90e4427a0f0b12746 |
|
MD5 | 86d1db385a205d0403d44f25dc1a7940 |
|
BLAKE2b-256 | 3d6da3c5f1ce9eba1da1b59ccada9b6af91386e0b9ba31c0f98afb6165d34177 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.12.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 600f614b04635f62b665251afe9869621a5750d31f53100447e15c5969202401 |
|
MD5 | 1b9a71e9453a63a1482f4f78b080687c |
|
BLAKE2b-256 | 1be6d9b6c5524033483d511fc8b7a46d29f857a9fe53b4dedf795dc2d934288c |