@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.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4243ee5e8e4a388cfc995e183be2a0899385a7959a7091180e1a48a129ea6c6a |
|
MD5 | a65e778076be73f92fbb12d267d19a8c |
|
BLAKE2b-256 | 5a40a89438c08f8154e6fb74d5df79ba035d9cf30b6fc7c5758285dec8fc7172 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8385ca9f67e077ab1e70d19f83874d12f848478ecf5a7b4564418d15553e36e3 |
|
MD5 | 9230bd23ce226abfcd767cb38bc0256d |
|
BLAKE2b-256 | 36b25f543934be66e00138732eb1055c6b35ee9c92f47b0228aee2005ffc9bb0 |