@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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba8318339efc15ada89159bde1886380b7326b51804680671e4f7bf9f8edf245 |
|
MD5 | afa2c7c717deaa7ebbf19d49614ed82d |
|
BLAKE2b-256 | b77e5855bd08b936a64b53bbd84ee67f0aa71c5cc0f54dd55902c88c7c0e7fe7 |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebe226ca717028439a13ae7d34c0db3d9b9939aa250da9ae6a08cb6c70cc7a05 |
|
MD5 | ba0bb55d193ba2fe426b7fe091718364 |
|
BLAKE2b-256 | 3468945423ccca07dbe4db6ea48ed71edc2ed4adbbd089efdc061ccf7f35cddc |