From a1a6bd70ec6c7ccf565596c670437bcfa715ad51 Mon Sep 17 00:00:00 2001 From: khanhtc1202 Date: Fri, 20 Sep 2024 14:02:38 +0900 Subject: [PATCH] Update deployment readme Signed-off-by: khanhtc1202 --- CONTRIBUTING.md | 1 + cmd/pipecd/README.md | 5 +++-- web/README.md | 12 ++++++++++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5c088c60b..71725dca6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,7 @@ If you're interested in contributing to PipeCD, this document will provide clear instructions on how to get involved. +> Note: Don't bother reading policies and flows, just want to manipulate the code? Jump to the [Development](#development) section. 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: diff --git a/cmd/pipecd/README.md b/cmd/pipecd/README.md index 9e78bdc79a..8815c8589e 100644 --- a/cmd/pipecd/README.md +++ b/cmd/pipecd/README.md @@ -4,6 +4,7 @@ ## Prerequisites - [Go 1.22 or later](https://go.dev/) +- [NodeJS v20 or later](https://nodejs.org/en/) - [Docker](https://www.docker.com/) - [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) (If you want to run Control Plane locally) - [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 ## How to run Control Plane locally -1. Start running a Kubernetes cluster +1. Start running a Kubernetes cluster (If you don't have any Kubernetes cluster to use) ``` console make kind-up @@ -53,4 +54,4 @@ For the full list of available commands, please see the Makefile at the root of 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`. ## How to run Piped locally and add an application to your cluster -See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally). \ No newline at end of file +See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally). diff --git a/web/README.md b/web/README.md index b63d35837a..30cc40717e 100644 --- a/web/README.md +++ b/web/README.md @@ -28,7 +28,19 @@ src ## Development +### Prerequisites + +- [NodeJS v20 or later](https://nodejs.org/en/) +- [Yarn](https://yarnpkg.com/) + ### Running with Mocks(msw) + +First time running, you need to install dependencies. + +```bash +make update/web-deps +``` + We use `msw` for mocking API, so you can see UI without running API server. ```bash