Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/publicodes/model-template
Template de repo pour modèle Publicodes
https://github.com/publicodes/model-template
publicodes template-project
Last synced: about 2 months ago
JSON representation
Template de repo pour modèle Publicodes
- Host: GitHub
- URL: https://github.com/publicodes/model-template
- Owner: publicodes
- License: mit
- Created: 2023-09-05T14:38:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-30T10:30:22.000Z (5 months ago)
- Last Synced: 2024-08-29T18:34:10.470Z (4 months ago)
- Topics: publicodes, template-project
- Language: JavaScript
- Homepage:
- Size: 665 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Publicodes Package Template
Report Bug
•
API docs
•
Contribute
•
Publicodes
Template dépôt GitHub pour créer un paquet Publicodes.
## Fonctionnalités
- 📦 compilation des règles publicodes en un seul fichier JSON grâce à
[`@incubateur-ademe/publicodes-tools`](https://github.com/publicodes/publicodes-tools)
- 📖 documentation du modèle interactive disponible sur GitHub Pages grâce à
[`@publicodes/react-ui`](https://publi.codes/docs/api/react-ui)
- 🚀 API REST pour utiliser le modèle dans une application grâce à
[`@publicodes/api`](https://publi.codes/docs/api/api-rest)
## Initialisation
Pour utiliser ce template, il suffit de cliquer sur le bouton `Use this
template`. Puis de remplacer les variables suivantes dans tous les fichiers du
projet :
- `model-template` : nom du paquet npm / nom du repository GitHub
- `publicodes` : nom d'utilisateur GitHub / organisation GitHub
Pour utiliser les fonctionnalités de la CI :
1. Il faut décommenter les fichiers `./github/workflows/*.yaml`
2. Ajouter les variables suivantes dans les secrets du repository GitHub : - `NPM_TOKEN` : token NPM pour publier le paquet sur [npmjs.com](https://npmjs.com) - `PAT` : Personal Access Token pour publier la documentation sur GitHub Pages
3. Aller dans les paramètres du repository GitHub et : - modifier les droits des worflows
 - sélectionner la branche `gh-pages` dans les paramètres du repository
## Exemples de dépôts utilisant ce template
- [`@incubateur-ademe/publicodes-commun`](https://github.com/incubateur-ademe/publicodes-commun) -
_Ensemble de règles communes utilisées pour l'implémentation des modèles Publicodes de l'incubateur_
- [`@incubateur-ademe/publicodes-negaoctet`](https://github.com/incubateur-ademe/publicodes-negaoctet) -
_Modèle Publicodes pour la base de données NegaOctet_
- [`@incubateur-ademe/publicodes-impact-livraison`](https://github.com/incubateur-ademe/publicodes-negaoctet) -
_Modèle [Publicodes](https://publi.codes) pour le simulateur [Impact Livraison](https://impactco2.fr/livraison)_
- [`ekofest/publicodes-evenements`](https://github.com/ekofest/publicodes-evenements) -
_Modèle Publicodes pour le calcul de l'impact environnemental des événements_
## Usage
Ajouter le paquet à vos dépendances :
```
yarn add model-template
```
Instancier un nouveau moteur Publicode :
```typescript
import Engine from "publicodes"
import rules from "model-template"
const engine = new Engine(rules)
engine.evaluate("dépenses primeur")
```
Utiliser certaines règles dans un autre modèle publicodes :
```yaml
importer!:
depuis:
nom: model-template
url: https://github.com/publicodes/model-template
les règles:
- prix . carottes
- prix . carottes
- prix . avocats
```
### En local
#### Compiler le modèle
> Les règles publicodes du modèle sont disponible dans le workspace
> [`rules/`](https://github.com/publicodes/model-template/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 build
```
#### Lancer la documentation
> Le code de la documentation est disponible dans le workspace
> [`doc/`](https://github.com/publicodes/model-template/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 install --cwd doc
yarn doc
```
#### Lancer l'API
> Le code de l'API est disponible dans le workspace
> [`api/`](https://github.com/publicodes/model-template/tree/main/api).
Pour lancer le serveur Node permettant d'utiliser l'API REST, il faut utiliser les commandes
suivantes :
```
yarn install --cwd api
yarn api
```
## Publier une nouvelle version
Afin de publier une nouvelle version il suffit d'exécuter la commande `npm
version`.