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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.52.tar.gz
Algorithm Hash digest
SHA256 71daddf921314f450ed8d6ce2ce75828196fe79daf6b8d761fc6144791177e7f
MD5 9c73ae9cd48fc4e50957722d83e9bb25
BLAKE2b-256 357668483da60de6c56f5295cf793afcaf34d818543d1a0095073623c1962efe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.52-py3-none-any.whl
Algorithm Hash digest
SHA256 529d89aa77e8c5f9ad65fe5cab5544452519265cfb84f9e9600114ecf2e3329d
MD5 a705f1b1fd7ff4b27ac03c0dad88e357
BLAKE2b-256 c791d405a7daaf5cb709f5bb2de3157318acd6dbf8e6e593ade70392f63917e2

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