Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update deployment readme #5220

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Update deployment readme #5220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
5 changes: 3 additions & 2 deletions cmd/pipecd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down Expand 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).
See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally).
12 changes: 12 additions & 0 deletions web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading