You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/11/08 18:59:58 UTC
[GitHub] [beam] damccorm commented on a diff in pull request #23509: Adding a quickstart to README for the TS SDK
damccorm commented on code in PR #23509:
URL: https://github.com/apache/beam/pull/23509#discussion_r1017009662
##########
sdks/typescript/README.md:
##########
@@ -38,6 +38,66 @@ to running on production runners such as Dataflow and Flink.
The target audience should hopefully not be put off by running other-language
code encapsulated in docker images.
+## Getting started
+
+To instal and test the Typescript SDK from source, you will need `npm` and
+`python`. Other requirements can be installed by `npm` later on.
+
+(**Note** that Python is a requirement as it is used to orchestrate Beam
+functionality.)
+
+1. First you must clone the Beam repository and go to the `typescript` directory.
+```
+git checkout https://github.com/apache/beam
+cd beam/sdks/typescript/
+```
+
+2. Execute a local install of the necessary packages:
+
+```
+npm install
+```
+
+3. Then run `./build.sh` to transpile Typescript files into JS files.
+
+### Development workflows
+
+All of the development workflows (build, test, lint, clean, etc) are defined in
+`package.json`.
Review Comment:
```suggestion
`package.json` and can be run with `npm` commands (e.g. `npm run build`).
```
##########
sdks/typescript/README.md:
##########
@@ -38,6 +38,66 @@ to running on production runners such as Dataflow and Flink.
The target audience should hopefully not be put off by running other-language
code encapsulated in docker images.
+## Getting started
+
+To instal and test the Typescript SDK from source, you will need `npm` and
Review Comment:
```suggestion
To install and test the Typescript SDK from source, you will need `npm` and
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org