@dxdeveloperexperience/hygie - npm Package Compare versions

Comparing version 0.22.0 to 0.23.0

docs/.vuepress/config.js

@@ -6,2 +6,123 @@ module.exports = {
     "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.",
+
+  head: [
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '57x57',
+        href: '/assets/favicon/apple-icon-57x57.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '60x60',
+        href: '/assets/favicon/apple-icon-60x60.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '72x72',
+        href: '/assets/favicon/apple-icon-72x72.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '76x76',
+        href: '/assets/favicon/apple-icon-76x76.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '114x114',
+        href: '/assets/favicon/apple-icon-114x114.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '120x120',
+        href: '/assets/favicon/apple-icon-120x120.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '144x144',
+        href: '/assets/favicon/apple-icon-144x144.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '152x152',
+        href: '/assets/favicon/apple-icon-152x152.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'apple-touch-icon',
+        sizes: '180x180',
+        href: '/assets/favicon/apple-icon-180x180.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'icon',
+        type: 'image/png',
+        sizes: '192x192',
+        href: '/assets/favicon/android-icon-192x192.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'icon',
+        type: 'image/png',
+        sizes: '32x32',
+        href: '/assets/favicon/favicon-32x32.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'icon',
+        type: 'image/png',
+        sizes: '96x96',
+        href: '/assets/favicon/favicon-96x96.png',
+      },
+    ],
+    [
+      'link',
+      {
+        rel: 'icon',
+        type: 'image/png',
+        sizes: '16x16',
+        href: '/assets/favicon/favicon-16x16.png',
+      },
+    ],
+    ['link', { rel: 'manifest', href: '/assets/favicon/manifest.json' }],
+    ['meta', { name: 'msapplication-TileColor', content: '#ffffff' }],
+    [
+      'meta',
+      {
+        name: 'msapplication-TileImage',
+        content: '/assets/favicon/favicon/ms-icon-144x144.png',
+      },
+    ],
+    ['meta', { name: 'theme-color', content: '#ffffff' }],
+  ],
   themeConfig: {
@@ -31,3 +152,2 @@ repo: 'zenika-open-source/hygie',
     sidebar: [
-      '/',
       {
@@ -34,0 +154,0 @@ title: 'Guide',

docs/README.md

@@ -1,29 +0,32 @@
-# Hygie
+<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
+# Motivation
 
-**_Hygie_** is an easy-to-use Open-Source REST API allowing you to interact with GIT events.
+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?
 
-This [NestJs](https://docs.nestjs.com/) API expose a set of customizable Rules to automate your project's life cycle and ensure that your team respect your good practices.
+With **_Hygie_** you can do all these stuff and much more, with only one app and configuration file!
 
-## Prerequisite
+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_**.
 
-This API is available for [Github](https://github.com) and [Gitlab](https://about.gitlab.com/) repositories.
+**_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.
 
-Other Git version control systems will maybe available in the future. Do not hesitate to ask for one of them.
+# Quick Getting Started
 
-## 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.
 
-To use our solution, just [register your application](./guide/registerToken.md): 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](./guide/gettingStarted.md).
+For more informations, read the [Getting Started section](https://zenika-open-source.github.io/hygie/guide/gettingStarted.html).
 
-## Contribution
+# Wanna host your own _Hygie_ app?
 
-If you want to contribute to this project, fill free to create Pull Request.
+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.
 
-Every new rule or runnable are welcomed!
+# Keywords
 
-Keywords : [#NestJs](), [#NodeJs](), [#TypeScript](), [#Docker](), [#Webhooks](), [#FaaS](), [#Github](), [#GitLab](), [#CI](), [#Open-Source]()...
+[#NestJS](), [#Node.js](), [#TypeScript](), [#Docker](), [#Webhooks](), [#FaaS](), [#Github](), [#GitLab](), [#CI](), [#Open-Source]()...

docs/rules/README.md

@@ -6,1 +6,2 @@ # Rules
 - [.rulesrc example](rulesExample.md)
+- [Groups](groups.md)

package.json

 {
   "name": "@dxdeveloperexperience/hygie",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "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.",
@@ -65,3 +65,3 @@ "license": "MIT",
   "devDependencies": {
-    "@dxdeveloperexperience/hygie-cli": "0.3.1",
+    "@dxdeveloperexperience/hygie-cli": "0.5.0",
     "@nestjs/cli": "6.5.0",
@@ -75,3 +75,3 @@ "@types/express": "4.17.0",
     "@types/handlebars": "4.1.0",
-    "coveralls": "3.0.4",
+    "coveralls": "3.0.5",
     "cpx": "1.5.0",
@@ -78,0 +78,0 @@ "husky": "3.0.0",

README.md

@@ -1,17 +0,27 @@
-# Hygie
+<p align="center">
+  <a href="https://zenika-open-source.github.io/hygie" target="blank"><img src="public/hygie/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>
+<p align="center">
+    <a href="https://coveralls.io/github/zenika-open-source/hygie?branch=master" target="blank"><img src="https://coveralls.io/repos/github/zenika-open-source/hygie/badge.svg?branch=master" alt="Coverage Status" /></a>
+    <a href="https://circleci.com/gh/zenika-open-source/hygie" target="blank"><img src="https://img.shields.io/circleci/project/github/zenika-open-source/hygie/master.svg" alt="CircleCI Build" /></a>
+    <a href="https://www.npmjs.com/package/@dxdeveloperexperience/hygie" target="blank"><img src="https://img.shields.io/npm/v/@dxdeveloperexperience/hygie.svg" alt="NPM" /></a>
+    <a href="https://github.com/zenika-open-source/hygie/releases" target="blank"><img src="https://img.shields.io/github/release/zenika-open-source/hygie.svg" alt="GitHub release" /></a>
+    <a href="#" target="blank"><img src="https://img.shields.io/github/languages/code-size/zenika-open-source/hygie.svg" alt="GitHub code size in bytes" /></a>
+    <a href="https://zenika-open-source.github.io/hygie/" target="blank"><img src="https://img.shields.io/website/https/zenika-open-source.github.io/hygie.svg" alt="Website" /></a>
+    <a href="https://discord.gg/w5AE8vS" target="blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord" /></a>
+</p>
 
-[![Coverage Status](https://coveralls.io/repos/github/zenika-open-source/hygie/badge.svg?branch=master)](https://coveralls.io/github/zenika-open-source/hygie?branch=master)
-[![CircleCI branch](https://img.shields.io/circleci/project/github/zenika-open-source/hygie/master.svg)](https://circleci.com/gh/zenika-open-source/hygie)
-[![npm](https://img.shields.io/npm/v/@dxdeveloperexperience/hygie.svg)](https://www.npmjs.com/package/@dxdeveloperexperience/hygie)
-![GitHub release](https://img.shields.io/github/release/zenika-open-source/hygie.svg)
-![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/zenika-open-source/hygie.svg)
-[![Website](https://img.shields.io/website/https/zenika-open-source.github.io/hygie.svg)](https://zenika-open-source.github.io/hygie/)
-[![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)](https://discord.gg/w5AE8vS)
-
 ## Motivation
 
-**_Hygie_** is an easy-to-use Open-Source REST API allowing you to interact with GIT events.
+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?
 
-This [NestJs](https://docs.nestjs.com/) API expose a set of customizable Rules to automate your project's life cycle.
+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
@@ -27,6 +37,10 @@
 
-Check-out our [documentation website](https://zenika-open-source.github.io/hygie/) for more informations.
+Check-out our [documentation website](https://zenika-open-source.github.io/hygie/) for more informations about the configuration file and the workflow you can create.
 
+## 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]()...

src/main.ts

@@ -10,5 +10,7 @@ import { NestFactory } from '@nestjs/core';
 import { NestExpressApplication } from '@nestjs/platform-express';
+import { join } from 'path';
 
 async function bootstrap() {
   const app = await NestFactory.create<NestExpressApplication>(AppModule);
+  app.useStaticAssets(join(__dirname, '..', 'public'));
 
@@ -15,0 +17,0 @@ // Handle every exceptions

No alert changes

Improved metrics

Total package byte prevSize

1275384

increased by34.2%

Number of package files

272

increased by14.77%

Number of lines in readme file

46

increased by43.75%

Worsened metrics

Lines of code

21124

decreased by-0.18%

No dependency changes