@dxdeveloperexperience/hygie/docs/README.md

Hygie is an easy-to-use Open-Source REST API allowing you to interact with GIT events. This NestJS API expose a set of customizable rules to automate your project's life cycle.

<p align="center">
  <a href="https://zenika-open-source.github.io/hygie" target="blank"><img src="./assets/hygie-horizontal-medium.png" alt="Hygie Logo" /></a>
</p>
<p align="center">
    An easy-to-use Open-Source API to manage and automate your project's life cycle.
</p>

# Motivation

Tired to add and configure a lot of apps like [stale](https://github.com/marketplace/stale), [lock](https://github.com/apps/lock), [WIP](https://github.com/marketplace/wip) or [trafico](https://github.com/marketplace/trafico-pull-request-labeler) to manage your GIT project?

With **_Hygie_** you can do all these stuff and much more, with only one app and configuration file!

Updating commit status, creating _work in progress_ pull request, auto-closing outdated issues or pull requests, interacting with external API, deploying your documentation, creating CRON jobs... all these things you can do with **_Hygie_**.

**_Hygie_** is an easy-to-use Open-Source REST API allowing you to interact with GIT events. It expose a set of customizable Rules to automate your project's life cycle.

# Quick Getting Started

To use our solution, just [register your application](https://zenika-open-source.github.io/hygie/guide/registerToken.html): this will create a _webhook_ in your repository and an `Connected to Hygie!` issue, to ensure that everything worked fine.

You can now create your configuration file to fit your needs, or continue working on your project without any changes and using our default configuration file, with our _good practices_.

For more informations, read the [Getting Started section](https://zenika-open-source.github.io/hygie/guide/gettingStarted.html).

# Wanna host your own _Hygie_ app?

Have a look at the [dedicated section](https://zenika-open-source.github.io/hygie/guide/selfHosted.html) if you want to host your own instance of our **_Hygie_** app.

# Keywords

[#NestJS](), [#Node.js](), [#TypeScript](), [#Docker](), [#Webhooks](), [#FaaS](), [#Github](), [#GitLab](), [#CI](), [#Open-Source]()...