@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.5.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 932c7e03f06ca8a1da94d9b00406afd90da3ee0c161f548497d70321fb75340d |
|
MD5 | 5e6890e02fc035afcf260c7215e48b87 |
|
BLAKE2b-256 | 9f7887bfdfe324f20c72899a2c2e3c8bffc9771a3946316c6a00e119f9a884ab |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.5.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a67731df9856b6cd7ecc17b137ad3ada9491f3a440307fdd517597fba34615a4 |
|
MD5 | 1ea41f54b0518a8956a366c14d0dfb25 |
|
BLAKE2b-256 | bb55fac85b75cb137236ac9faa8fe5f4fd6921689a05c0b39a3b0d8bc7ea04a9 |