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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.11.7.tar.gz
Algorithm Hash digest
SHA256 8d380df5630b36981c1da5fb3bdce597ef2757c3c79990f0a85e906000a27655
MD5 839ec4b62e11dbfb38124864c5947515
BLAKE2b-256 b435c3426a072cd26df3fc97d38dd63d34eafdcffda65e3f75303903bd86c867

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.11.7-py3-none-any.whl
Algorithm Hash digest
SHA256 26b135b4dabeb38f94e7003a25a7ed8065fd931845d9ef8f970a018df1c8f868
MD5 f15e20ec9f6b2840fc100a100adcbb6e
BLAKE2b-256 ef93f35c8f6fbe250a6c9c0279f1ee06d8d2d52b7b53bcb047249b010878f960

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