Skip to content

Latest commit

 

History

History
125 lines (92 loc) · 3.99 KB

README.md

File metadata and controls

125 lines (92 loc) · 3.99 KB
Raw

weave-gitops

Weave GitOps

Coverage Status Test status LICENSE Contributors Release

Overview

Weave GitOps enables an effective GitOps workflow for continuous delivery of applications into Kubernetes clusters. It is based on CNCF Flux, a leading GitOps engine.

Early access

Weave GitOps is in early stages and iterating. Not all capabilities are available yet, and the CLI commands and other aspects may change. Please be aware this is not production ready yet. We would appreciate feedback and contributions of all kinds at this stage.

Getting Started

CLI Installation

Mac / Linux

curl -L https://github.com/weaveworks/weave-gitops/releases/download/v0.1.0/wego-$(uname)-$(uname -m) -o wego
chmod +x wego
sudo mv ./wego /usr/local/bin/wego
wego version

Please see the getting started guide.

CLI Reference

Weave GitOps

Usage:
  wego [command]

Available Commands:
  app         Add or Status application
  flux        Use flux commands
  help        Help about any command
  install     Install or upgrade Wego
  version     Display wego version

Flags:
  -h, --help               help for wego
      --namespace string   gitops runtime namespace (default "wego-system")
  -v, --verbose            Enable verbose output

Use "wego [command] --help" for more information about a command.

For more information please see the docs

CLI/API development

To set up a development environment for the CLI

  1. Install go v1.16
  2. Install buf
  3. make

UI Development

To set up a development environment for the UI

  1. Install go v1.16
  2. Install Node.js version 14.15.1
  3. Install reflex for automated server builds: go get github.com/cespare/reflex
  4. Run npm install
  5. To start up the HTTP server with automated re-compliation, run make ui-dev
  6. Run npm start to start the frontend dev server (with hot-reloading)

Lint frontend code with make ui-lint

Run frontend tests with make ui-test

Check dependency vulnerabilities with make ui-audit

Recommended Snippets

To create a new styled React component (with typescript):

{
  "Export Default React Component": {
    "prefix": "tsx",
    "body": [
      "import * as React from 'react';",
      "import styled from 'styled-components'",
      "",
      "type Props = {",
      "  className?: string",
      "}",
      "",
      "function ${1:} ({ className }: Props) {",
      "  return (",
      "    <div className={className}>",
      "      ${0}",
      "    </div>",
      "  );",
      "}",
      "",
      "export default styled(${1:})``"
    ],
    "description": "Create a default-exported, styled React Component."
  }
}

Contribution

Need help or want to contribute? Please see the links below.