@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.46.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4635bdc986eef20aac6f6b2c3ecc018b49bbe862f6c0cafd545d31fe426c8b3d |
|
MD5 | cb1a5a1001c5eb3643a45e7a41b6de5d |
|
BLAKE2b-256 | 5d6b675e339f6048a0585e8e19ae2e56dd33b7510150715c8c624d1798580f29 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.46-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dad40b26ea5ab68007a97e5e644f70ed561172b9d41e59d0f283e033953409f8 |
|
MD5 | 734adae888414dbca4fcee8d39081860 |
|
BLAKE2b-256 | 3b427cd9e1c4e3957b3364b2f01416335f89b0495171a4890b93526ba95aa428 |