@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.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 507a9dcdd680039fbf3767c73bc3236a8cc3f48dbde84b711daa5f5bc01b21ba |
|
MD5 | 23431d6676d1b1ebcda46514af6a30d1 |
|
BLAKE2b-256 | f3f8a0c201fe892073eeda790060c680976baefb65e6bdba80125a41e04216d9 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbf01098f7264fec0d6a451e27f0d6fcbd082db9fb02802256c536b4392bd656 |
|
MD5 | 811c12815b0254fc43d5e15ca5b3f02a |
|
BLAKE2b-256 | df3b707242f5a36f6b098f7bb0cc70310a663c54dcd73c517d65250ccc6dc787 |