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.19.29.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.29.tar.gz
Algorithm Hash digest
SHA256 fe242d60cd9b9e25e48880a8d38f9d3c91211d38af04f634d5624eea807b12b2
MD5 4dc2c8d271be697ee9fe4c53641880a8
BLAKE2b-256 1b45cfd590a05cce33e55f98d342f9e4d8c48b855fabd4b228efa121db76cae0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.29-py3-none-any.whl
Algorithm Hash digest
SHA256 8ac009c95933ef864eee9daba98fbe11cdd689dff9cf8b80c3bff492d3d84605
MD5 015aa4961000289b2881659bd2aac5c1
BLAKE2b-256 35345217257eaa47a33ed78feda032629bf36723eee121d14344c242c91cecd8

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