https://github.com/incubateur-ademe/publicodes-impact-livraison

Modèle Publicodes sur les données "Livraison" pour Impact CO2
https://github.com/incubateur-ademe/publicodes-impact-livraison

Last synced: 4 months ago
JSON representation

Modèle Publicodes sur les données "Livraison" pour Impact CO2

• Host: GitHub
• URL: https://github.com/incubateur-ademe/publicodes-impact-livraison
• Owner: incubateur-ademe
• License: mit
• Created: 2023-09-25T15:29:30.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-27T14:33:36.000Z (9 months ago)
• Last Synced: 2024-04-29T20:16:15.323Z (8 months ago)
• Language: JavaScript
• Homepage: https://incubateur-ademe.github.io/publicodes-impact-livraison/
• Size: 1.1 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


	Publicodes x Impact Livraison

  

  


   Report Bug

   •

   API docs

   •

   Contribute

  


![CI][ci-link] ![NPM][npm-link]

Un modèle [Publicodes](https://publi.codes) pour le simulateur

[Impact Livraison](https://impactco2.fr/livraison) de [Impact CO2](https://impactco2.fr).

Sa documentation est disponible [en

ligne](https://incubateur-ademe.github.io/publicodes-impact-livraison/).



## Usage

Ajouter le paquet à vos dépendances :

```

yarn add @incubateur-ademe/publicodes-impact-livraison

```

Instancier un nouveau moteur Publicode :

```typescript

import Engine from 'publicodes'

import rules from '@incubateur-ademe/publicodes-impact-livraison'

const engine = new Engine(rules)

engine.evaluate('livraison colis . scénario . domicile')

```

Utiliser certaines règles dans un autre modèle publicodes :

```yaml

importer!:

  depuis:

    nom: '@incubateur-ademe/publicodes-impact-livraison'

    url: https://github.com/incubateur-ademe/publicodes-impact-livraison

  dans: modèle livraison

  les règles:

    - livraison colis . scénario . domicile

    - livraison colis par avion

```

### En local

#### Compiler le modèle

> Les règles publicodes du modèle sont disponible dans le workspace

> [`rules/`](https://github.com/incubateur-ademe/publicodes-impact-livraison/tree/main/rules).

Pour installer les dépendances et compiler tous les fichiers `.publicodes` en

un seul fichier JSON, il suffit d'exécuter la commande suivante :

```

yarn && yarn run build

```

#### Lancer la documentation

> Le code de la documentation est disponible dans le workspace

> [`doc/`](https://github.com/incubateur-ademe/publicodes-impact-livraison/tree/main/doc).

Pour lancer l'app React en local permettant de parcourir la documentation du

modèle, il suffit d'exécuter la commande suivante :

```

yarn i --cwd doc

yarn run doc

```

#### Lancer l'API

> Le code de l'API est disponible dans le workspace

> [`api/`](https://github.com/incubateur-ademe/publicodes-impact-livraison/tree/main/api).

Pour lancer le serveur Node permettant d'utiliser l'API REST, il faut utiliser les commandes

suivantes :

```

yarn run api

# En watch-mode

yarn run api:watch

```

## Publier une nouvelle version

Afin de publier une nouvelle version il suffit d'exécuter la commande `npm

version`.

[ci-link]: https://img.shields.io/github/actions/workflow/status/incubateur-ademe/publicodes-impact-livraison/packaging.yaml?logo=github&logoColor=white&label=build%20%26%20test

[npm-link]: https://img.shields.io/npm/v/%40incubateur-ademe%2Fpublicodes-impact-livraison?logo=npm&logoColor=white&color=salmon