Skip to content

Commit

Permalink
docs: minor tweaks
Browse files Browse the repository at this point in the history
-add mention to test running via interface
-explain in more detail the docker requirement
-fix small bug preventing the correct execution of generate-api-server

Signed-off-by: Rafael Belchior <rafael.belchior@tecnico.ulisboa.pt>
  • Loading branch information
RafaelAPB authored and petermetz committed Mar 8, 2022
1 parent ed6e164 commit 597bfdd
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
9 changes: 5 additions & 4 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,9 @@ The `npm run watch` script in action:
```
* Yarn
* `npm run install-yarn` (from within the project directory)
* Docker Engine
* Docker Compose
* [Docker Engine](https://docs.docker.com/engine/install/ubuntu/). Make sure that Docker is working and running, for example, running ``docker ps -aq``
* Docker Compose
* OpenJDK (Corda support Java 8 JDK but do not currently support Java 9 or higher)
* `sudo apt install openjdk-8-jdk-headless`
Expand All @@ -124,7 +125,7 @@ cd cactus
* Run the initial configuration script (can take a long time, 10+ minutes on a low-spec laptop)

```sh
npm run configure
yarn run configure
```

At this point you should have all packages built for development.
Expand Down Expand Up @@ -212,7 +213,7 @@ the following decision tree (and keep in mind that we have `npm run watch` too)

![Build Script Decision Tree](./docs/images/build-script-decision-tree-2021-03-06.png)

## Getting into the SSH connection
## Configuring SSH to use upterm
Upload your public key onto github if not done so already. A public key is necessary to join the ssh connection to use upterm. For a comprehensive guide, see the [Generating a new SSH key and adding it to the ssh-agent](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).

Locate the `ci.yml` within `.github/workflows` and add to the `ci.yml` code listed below:
Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,8 @@ for both them separately anyway:
npx jest packages/cactus-common/src/test/typescript/unit/objects/get-all-method-names.test.ts
```
You can also run tests via the VS Code user interface. To do so, make sure you rename ``template.launch.json`` to ``launch.json`. Under the "Run and Debug" window of VS Code, select "JEST: Current TS file" to test the currently opened file.
#### Running all test cases (unit+integration)
```sh
Expand Down
2 changes: 1 addition & 1 deletion tools/generate-api-server-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { ConfigService } from "../packages/cactus-cmd-api-server/dist/lib/main/t

const main = async () => {
const configService = new ConfigService();
const config = configService.newExampleConfig();
const config = await configService.newExampleConfig();
const configJson = JSON.stringify(config, null, 4).concat("\n");

if (fs.existsSync(config.configFile)) {
Expand Down

0 comments on commit 597bfdd

Please sign in to comment.