Skip to content

Commit 7110f15

Browse files
committed
docs(readme): add reference to BUILD.md
BUILD.md: add GIF showcasing the watch script We've received feedback from multiple people that long build times are tedious and reduce general productivity which is (probably) hindering the growth of the community so here is a video guide (GIF) on how fast builds can be achieved by only rebuilding what you actually changed on the package level. It also comes with support for regenerating the code that we don't write ourselves but use the OpenAPI generator for it instead. All the openapi.json files are being watched by the `npm run watch` script for code changes the same way that Typescript files are being watched so this just works out of the box. Signed-off-by: Peter Somogyvari <[email protected]>
1 parent 4c96714 commit 7110f15

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

BUILD.md

+17
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,23 @@ machine or if you are planning on contributing.
1010
1111
The project uses Typescript for both back-end and front-end components.
1212

13+
## Fast Developer Flow / Code Iterations
14+
15+
We put a lot of thought and effort into making sure that fast developer iterations can be
16+
achieved (please file a bug if you feel otherwise) while working **on** the framework.
17+
18+
If you find yourself waiting too much for builds to finish, most of the time
19+
that can be helped by using the `npm run watch` script which can automatically
20+
recompile packages as you modify them (and only the packages that you have
21+
modified, not everything).
22+
23+
It also supports re-running the OpenAPI generator when you update any
24+
`openapi.json` spec files that we use to describe our endpoints.
25+
26+
The `npm run watch` script in action:
27+
28+
![Fast Developer Flow / Code Iterations](./docs/hyperledger-cactus-watch-script-tutorial-2021-03-06.gif)
29+
1330
## Getting Started
1431

1532
* Install OS level dependencies:

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ Once the last command has finished executing, open link printed on the console w
5353
* mailing list: [[email protected]](mailto:[email protected])
5454
* rocketchat channel: [https://chat.hyperledger.org/channel/cactus](https://chat.hyperledger.org/channel/cactus).
5555

56+
## Build/Development Flow
57+
58+
To go from zero to hero with project setup and working on your contributions: [BUILD.md](./BUILD.md)
59+
5660
## Contributing
5761
We welcome contributions to Hyperledger Cactus in many forms, and there’s always plenty to do!
5862

Loading

0 commit comments

Comments
 (0)