@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.38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4181bd37480b61b062e28682e41a9d25212f3182f42fc65b73dbdcc356f31baa |
|
MD5 | 829187196b1824aca867bb4186c1dcb0 |
|
BLAKE2b-256 | 25c855f2e872729d4df4188332cfc5cb4a8f12481aac43c5af6d637de4d86e9c |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.38-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f55aaa40ec8fa69b5aa8c07147fbf79ccb41bad3b112b19c81044d8a968152e |
|
MD5 | e3be85ec814c70c09f19c7ac37ad7c8b |
|
BLAKE2b-256 | 0fdae0b6317bdbdf7339c41bf145c25f870e11ac90f18eb89e7eca6170fa0e9b |