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
Release files for aws-prototyping-sdk.cloudscape-react-ts-website 0.8.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws_prototyping_sdk.cloudscape_react_ts_website-0.8.3.tar.gz | 81.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_prototyping_sdk.cloudscape_react_ts_website-0.8.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 160.8 kB
Release files / aws_prototyping_sdk.cloudscape_react_ts_website-0.8.3.tar.gz
| Download URL | aws_prototyping_sdk.cloudscape_react_ts_website-0.8.3.tar.gz |
|---|---|
| Size | 81.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ac31e46fd7ce498c32096055597cff5684ff9950ac434fd2ce6ae6548a954299
|
|
BLAKE2b-256 checksum How to use checksums |
edd3c09bb92c905767356089cec2051a40d84f2162ec691108633c27469f9e44
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
Release files / aws_prototyping_sdk.cloudscape_react_ts_website-0.8.3-py3-none-any.whl
| Download URL | aws_prototyping_sdk.cloudscape_react_ts_website-0.8.3-py3-none-any.whl |
|---|---|
| Size | 79.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6e25b338ae4bfc1063d1b16887d3e66ff1b6eff087ccbeb45447ec2de28bee13
|
|
BLAKE2b-256 checksum How to use checksums |
5c2f192c77acb29eb2a5563cf310fdd2d50d27a1cd76cdb1346bb58aad91a394
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|