Skip to main content

@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

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws_prototyping_sdk.cloudscape_react_ts_website-0.7.2.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.7.2.tar.gz
Algorithm Hash digest
SHA256 2ca55879d808745a8df38e08f1b146e08e9293ab989ec6c719e255567113c44f
MD5 d7ea543f40b9f84905cf3c373fe8e6fb
BLAKE2b-256 a5ccfd1c3bc1a7c02319c90df9eb0e9e2b9934555bcb983f43d77d3c5d5e3413

See more details on using hashes here.

File details

Details for the file aws_prototyping_sdk.cloudscape_react_ts_website-0.7.2-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 939210eef52aa89b4e6e4dc0d4611412099515466a0f366c2393893f89fef8bb
MD5 a0db4bc2ae25a79e15fc45823f06e373
BLAKE2b-256 064a018e845203f0262dc09f918a40a23de97a22de59a88c53ec30121f4d39b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page