@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.33.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93fbee41cd424563f1ded62eb63708a13c97107526c8d48b214ca255f5dc960a |
|
MD5 | c0c3fc9d1a8fd47475b46fbad192b67c |
|
BLAKE2b-256 | 681d53d5d0fcd87734afa9c3b36056f02958f7f0cd459c2f404c9344f0a51f31 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.33-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 863164d893f35ba3a0def8a64d4acdec9ea30d7a68eefd6a70e1ac3b1f8790fb |
|
MD5 | 1c39d4c8eefab97dcde545393282361a |
|
BLAKE2b-256 | 181afdf6e8209354dc80d9b063d946fec8c447fb4519de30e58334338bf6e864 |