@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.62.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad3ebe7d7d5367ae9d42aca4c41ef0d16c02319ebfd496c27816d8d411f77b5e |
|
MD5 | 3b55cae859d04b1b4c652ecf05ee0fc8 |
|
BLAKE2b-256 | 0192b82954109fe24de1cdf4b976bbc66528c957060df1aa737e686d6687b397 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.62-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa4c7d89de6a83d68d37229bac92d93bda165b58533f5a4825b9c117bcd34c99 |
|
MD5 | 7a09ce6c2cc4d4771c85647e2fe5edf1 |
|
BLAKE2b-256 | 042f2b70649340dd04c2f90cdae860bb15d1b34ab802f5880636b00a8248060c |