@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
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fe44cae429f90d93d9e10e2afc6238f277f3db5e9c4f6f0480692ea7a9663a0 |
|
MD5 | a5a785586724cf9983cfcdbab7f22315 |
|
BLAKE2b-256 | 72b0fbddf004374bea88d60a0132621aaeaf32c9c10ad52717be83d65ec5b13c |
Hashes for aws_prototyping_sdk.cloudscape_react_ts_website-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcd17ca34723d0ea5f17b4ed4255a04d0ab62e67246616661c8a3e9dd607bd1a |
|
MD5 | b31a496919bc6b56a030c86cdc50f192 |
|
BLAKE2b-256 | c3fac3c85c9b8b9fd79a2b31e003fa3974a9d2cd31592ac8f2ab30ebab4fb07e |