Skip to content

Commit 083c810

Browse files
authored
Update deployment readme (#5220)
Signed-off-by: khanhtc1202 <[email protected]>
1 parent 65c98a6 commit 083c810

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
If you're interested in contributing to PipeCD, this document will provide clear instructions on how to get involved.
44

5+
> Note: Don't bother reading policies and flows, just want to manipulate the code? Jump to the [Development](#development) section.
56
67
The [Open Source Guides](https://opensource.guide/) website offers a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Both contributors and newcomers to open source will find the following guides especially helpful:
78

cmd/pipecd/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
## Prerequisites
55

66
- [Go 1.22 or later](https://go.dev/)
7+
- [NodeJS v20 or later](https://nodejs.org/en/)
78
- [Docker](https://www.docker.com/)
89
- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) (If you want to run Control Plane locally)
910
- [helm 3.8](https://helm.sh/docs/intro/install/) (If you want to run Control Plane locally)
@@ -22,7 +23,7 @@ For the full list of available commands, please see the Makefile at the root of
2223

2324
## How to run Control Plane locally
2425

25-
1. Start running a Kubernetes cluster
26+
1. Start running a Kubernetes cluster (If you don't have any Kubernetes cluster to use)
2627

2728
``` console
2829
make kind-up
@@ -53,4 +54,4 @@ For the full list of available commands, please see the Makefile at the root of
5354
Point your web browser to [http://localhost:8080](http://localhost:8080) to login with the configured static admin account: project = `quickstart`, username = `hello-pipecd`, password = `hello-pipecd`.
5455

5556
## How to run Piped locally and add an application to your cluster
56-
See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally).
57+
See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally).

web/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,19 @@ src
2828

2929
## Development
3030

31+
### Prerequisites
32+
33+
- [NodeJS v20 or later](https://nodejs.org/en/)
34+
- [Yarn](https://yarnpkg.com/)
35+
3136
### Running with Mocks(msw)
37+
38+
First time running, you need to install dependencies.
39+
40+
```bash
41+
make update/web-deps
42+
```
43+
3244
We use `msw` for mocking API, so you can see UI without running API server.
3345

3446
```bash

0 commit comments

Comments
 (0)