@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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c11654126ec02596a7097dd7162c92ec31358d1b45857a9804bf45eec5e96f92 |
|
MD5 | a0c9cf82398dc53816a749fbe47cde23 |
|
BLAKE2b-256 | 0f437693055cf24ed135c519856579da01fa3ad1fd496837ab2433d33c246f2a |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.12.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc077f1d15d063941edd3b0ebbc0bebd331a240c29eeb9a2f1a24ca18eae06d4 |
|
MD5 | d9e5b3f6c801715c7117f3ab8f48b15a |
|
BLAKE2b-256 | 03a30b3d73b0cb7b9bca567b24f1d482fd8c9fa78c7f653464e07c3f13c80d67 |