@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.44.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd1d6df0b4aef9d7a5913c4b73c078d5c9625a6a6025716fc7b4c727a41c9f39 |
|
MD5 | 9696f8d9b4c041c6c2374e865c73d37e |
|
BLAKE2b-256 | 259e264accfd7be269a07e979bd2bb73c8c821762cd0de931b8270ab5ca524cd |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.44-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de4c0126096e8599ffe0ca1dd1499949a85861a2e998171d5366c55232466def |
|
MD5 | 84bbd82b6bc5f4dc07f4f5cf8c8dac76 |
|
BLAKE2b-256 | dc318bab3e4c8646e7486adaa0d6ff0f92007295513a89ab8e568bc316c6ed54 |