@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.58.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d26edbbbe2e30315f54e38765b1c9eb8dffd31374d087cb12fcd6dd7592e689 |
|
MD5 | c21a659b51bb85db2a5427412c195f20 |
|
BLAKE2b-256 | f27b4ed116d76df3995fba4be60607abf46e197c257b245845567f962e97ce22 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.58-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23bd64d8aa99fc6222e92304104f6cb738dfc921aca4ead202c15046f8e62b47 |
|
MD5 | 88731a7c4c0a5645b1f3f2be91ac3d47 |
|
BLAKE2b-256 | 74be128d38d73b6906b3a84c30fb51fbf1a626b85d2234df4cc976311248522e |