README.md 5.4 KB
Newer Older
J
Jody 已提交
1
<p><a href="https://github.com/koderover/zadig-doc" target="_blank" rel="noopener noreferrer"><img height="50" src="https://docs.koderover.com/zadig/img/zadig.png" alt="Zadig logo"></a></p>
landylee007's avatar
landylee007 已提交
2 3 4 5 6

<h3 align="left">Developer-oriented Continuous Delivery Product</h3>

<span align="left">

T
The Codacy Badger 已提交
7
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2276bb4cce9348ceb8ddeeea5803ed57)](https://app.codacy.com/gh/koderover/zadig?utm_source=github.com&utm_medium=referral&utm_content=koderover/zadig&utm_campaign=Badge_Grade_Settings)
W
wanderleaf 已提交
8
[![Zadig CI](https://os.koderover.com/api/collie/api/badge?pipelineName=zadig-ci/zadig-ci&source=github&repoFullName=koderover/zadig&branch=main&eventType=push)](https://os.koderover.com/v1/projects/detail/zadig-ci/pipelines/freestyle/home/zadig-ci/608824fef341de000137317d?rightbar=step)
landylee007's avatar
landylee007 已提交
9 10
[![LICENSE](https://img.shields.io/github/license/koderover/zadig.svg)](https://github.com/koderover/zadig/blob/main/LICENSE)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
11 12
[![Go Report Card](https://goreportcard.com/badge/github.com/koderover/zadig)](https://goreportcard.com/report/github.com/koderover/zadig)
![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/koderover/zadig?include_prereleases)
W
wanderleaf 已提交
13
[!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://join.slack.com/t/zadig-workspace/shared_invite/zt-qedvct1t-mQUf2eyTRkoVCc_RWKKgxw)
landylee007's avatar
landylee007 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

</span>

<div align="left">

**English | [简体中文](./README-zh-CN.md)**

</div>

## Table of Contents

- [Zadig](#zadig)
  - [Table of Contents](#table-of-contents)
  - [What is Zadig](#what-is-zadig)
  - [Quick start](#quick-start)
    - [How to use?](#how-to-use)
    - [How to make contribution?](#how-to-make-contribution)
  - [Getting help](#getting-help)
  - [More resources](#more-resources)
  - [License](#license)

## What is Zadig

Zadig is an open-source, distributed, cloud-native CD (Continuous Delivery) product designed for developers. Zadig not only provides high-availability CI/CD capabilities, but also provides cloud-native operating environments, supports developers' local debugging, parallel build and deployment of microservices, integration testing, etc. .

Zadig is non-invasive, it does not exclude any of your existing development process. Instead it can easily integrate with Github/Gitlab, Jenkins and many other cloud vendors in a seamingless way. We strive for the 10x optimal developer experience with the lowest maintenance cost possible.

> Our vision is: Developer + Zadig = Business success

landylee007's avatar
landylee007 已提交
43

44
The business architecture is as follows:
landylee007's avatar
landylee007 已提交
45 46 47

![Business Architecture](./Zadig-Business-Architecture.jpg)

48 49
For more details about system architecture, see [Zadig System Architecture Overview](System-Architecture-Overview.md).

landylee007's avatar
landylee007 已提交
50
The Highlighted Features:
landylee007's avatar
landylee007 已提交
51

landylee007's avatar
landylee007 已提交
52 53 54 55
<details>
  <summary><b>High Concurrency</b></summary>
  Based on cloud-native design, through simple configuration, the system automatically generates workflows to achieve high concurrent execution for continuous delivery relevant tasks such as building, testing and deployment, across multiple services. It significantly improves the efficiency of multi-services deployment in microservice architecture.
  </details>
landylee007's avatar
landylee007 已提交
56

landylee007's avatar
landylee007 已提交
57 58 59
<details>
  <summary><b>Service-oriented Environment</b></summary>
  With just one set of service configuration, multiple encapsulated environments will be provided automatically within minutes, empowering independent environments for developers, QAs and product managers.
landylee007's avatar
landylee007 已提交
60

landylee007's avatar
landylee007 已提交
61 62
  Minimum to none migration cost of existing environments -- just hosting with one click, the system allows browsing and adjusting all the services at your fingertips.
  </details>
landylee007's avatar
landylee007 已提交
63

landylee007's avatar
landylee007 已提交
64 65 66
<details>
  <summary><b>Non-intrusive Testing Automation</b></summary>
  Zadig can easily and non-intrusively embed existing testing automation frameworks, and achieve continuous building, testing and deployment via GitHub/GitLab Webhook.
landylee007's avatar
landylee007 已提交
67

landylee007's avatar
landylee007 已提交
68 69
  It also integrates with productivity bots to provide instant quality report, which effectively applies shift-left testing best practices.
  </details>
landylee007's avatar
landylee007 已提交
70

landylee007's avatar
landylee007 已提交
71 72 73 74
<details>
  <summary><b>Convenient Development CLI/IDE Plugin</b></summary>
  Zadig also provides a convenient toolkit with development commandline interface which allows compiling, building and deploying the changes to dev environment with one command. It enables collaborated debugging and testing with minimum manual toil, reduces cognitive load and allows teams to focus more on business.
  </details>
landylee007's avatar
landylee007 已提交
75 76 77 78 79 80


## Quick start

### How to use?

Y
YuanPei Li 已提交
81
Please follow [Quick Start](https://docs.koderover.com/zadig/quick-start/try-out-install/)
landylee007's avatar
landylee007 已提交
82

landylee007's avatar
landylee007 已提交
83 84
### Bootcamps

landylee007's avatar
landylee007 已提交
85
With many hands-on tips, case studies and demos of different application types, Zadig [bootcamp](https://github.com/koderover/zadig-bootcamp) gives developers easy to follow best practices in a cloud native CI/CD solution
landylee007's avatar
landylee007 已提交
86

L
leozhang 已提交
87
Just follow [Tutorials](https://koderover.com/tutorials) to try it step by step.
landylee007's avatar
landylee007 已提交
88

landylee007's avatar
landylee007 已提交
89 90 91 92 93 94
### How to make contribution?

Please check out [our contributing guideline](CONTRIBUTING.md).

## Getting help

L
leozhang 已提交
95
- More about Zadig, see [here](https://docs.koderover.com?type=zadig)
landylee007's avatar
landylee007 已提交
96 97 98 99
- Submit bugs or feature requests following [contributing instructions](CONTRIBUTING.md#contribution-option-1---reporting-an-issue)
- Email:contact@koderover.com
- [Slack channel](https://join.slack.com/t/zadig-workspace/shared_invite/zt-qedvct1t-mQUf2eyTRkoVCc_RWKKgxw)

W
wanderleaf 已提交
100

landylee007's avatar
landylee007 已提交
101 102 103
## License

[Apache 2.0 License](./LICENSE)