Skip to content

Commit

Permalink
fix: improve build instructions (#6)
Browse files Browse the repository at this point in the history
Added more details on prerequisites.

Added `pdk install:ci` to install handlers package.

fixes #5
  • Loading branch information
jstrunk authored Dec 11, 2024
1 parent 4ed3156 commit e0ac27e
Show file tree
Hide file tree
Showing 8 changed files with 104 additions and 89 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,22 @@ The following table provides a sample cost breakdown for deploying this solution

### Prerequisites

* Node.js 18
* Git
* Python == 3.11
* Poetry >= 1.5.1 and < 1.9
* [Install prerequisites](https://aws.github.io/aws-pdk/getting_started/your_first_aws_pdk_project.html#prerequisites)
* Configure the AWS Credentials in your environment. Refer to [Authentication and access](https://docs.aws.amazon.com/sdkref/latest/guide/access.html).
* Download and install AWS CLI. Refer to [Installing the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
* Install and configure AWS CDK. Refer to Installing the [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html).
* Download and install Docker. Refer to [Docker](https://www.docker.com/products/docker-desktop/).
* NodeJS >= 18.0.0 and < 22
* Python >= 3.12 preferably with [pyenv](https://github.com/pyenv/pyenv)
* Poetry >= 1.5.1
* Pnpm >= 8.6.3 and < 9
* JDK >= 11 [Coretto](https://docs.aws.amazon.com/corretto/)
* Maven >= 3.8 [Maven](https://maven.apache.org/install.html)

```shell
pip install poetry
npm install -g pnpm@^8.15.9 aws-cdk
```


### First build

Expand All @@ -86,8 +97,8 @@ aws ecr-public get-login-password --region us-east-1 | docker login --username A
```

```shell
npx pnpm i
pnpm pdk
pnpm i
pnpm pdk install:ci
pnpm pdk build
```

Expand Down
14 changes: 7 additions & 7 deletions packages/api/generated/runtime/python/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 20 additions & 20 deletions packages/api/handlers/python/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion packages/infra/test/main.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ import { AwsSolutionsChecks } from "cdk-nag";
import { ApplicationStack } from "../src/stacks/application-stack";

test("No unsuppressed Errors", () => {
const app = new App();
const app = new App({
context: {
wordVectorsUrl: "https://testurl",
},
});
Aspects.of(app).add(new AwsSolutionsChecks());
const stack = new ApplicationStack(app, "test");
app.synth();
Expand Down
14 changes: 7 additions & 7 deletions packages/smart-product-onboarding/api/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 20 additions & 20 deletions packages/smart-product-onboarding/core-utils/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions packages/smart-product-onboarding/metaclasses/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit e0ac27e

Please sign in to comment.