@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.12.26.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f47d92ce046123b4fb3c74f71c2b896b3ce9f7d0d3886b95697f0dd0c4b75c6e |
|
MD5 | fa23d0827f18a428228669e5b2e7ad0b |
|
BLAKE2b-256 | 4b0478531a843b15b294c7b553e80aa15c5a03cff62399c9e7abe26efb24b4fe |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.12.26-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6bf1238c952c69abe71b443727173aa05774ee01bf634ab3097eb20071273e8d |
|
MD5 | f28e134daaf15276ee0b81eb2af494fe |
|
BLAKE2b-256 | cad257b7b5260c38fe70d130c0f9c89a5896b0bcd33b7ada7ff32edd5180a650 |