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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.39.tar.gz
Algorithm Hash digest
SHA256 6f18e29cb784960cc5706ffdad977c89dddae91964cc71fba0df4493f7192d3f
MD5 78b523e20abe0210bf2f69175f3a0cf0
BLAKE2b-256 2cf1593b7e42ce4f923cfe4a0139e653921b2c9c7329458ef3357258603c659f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.19.39-py3-none-any.whl
Algorithm Hash digest
SHA256 6531e79335e91d0f5707003077d132bd59ce0d900423dd86e9bb7b8cc4c86483
MD5 5076a3a9af7b33ce39def9bc28dc8ac9
BLAKE2b-256 6ca886394d1bc105169165ec4f33626eebe90ec173d61459c402184a6b70a98e

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