2021-11-05 14:52:37 +00:00
> 🇬🇧 Most of the documentation (including issues and commit messages) is written in French, please raise an [issue](https://github.com/betagouv/publicodes/issues/new) if you are interested and do not speak French. We intend to translate the language and the documentation in the coming weeks.
2021-05-12 14:12:14 +00:00
2021-11-05 14:52:37 +00:00
## <a href="https://publi.codes"><img src="https://mon-entreprise.fr/images/logo-publicodes.png" alt="Publicodes" width="200"/></a>
2020-06-02 16:37:59 +00:00
2021-11-05 14:52:37 +00:00
[![Npm version ](https://img.shields.io/npm/v/publicodes )](https://www.npmjs.com/package/publicodes)
[![Gitter chat ](https://badges.gitter.im/publicodes/publicodes.png )](https://gitter.im/publicodes/community)
2020-01-21 09:50:18 +00:00
2021-11-05 14:52:37 +00:00
Publicodes est un langage déclaratif pour encoder les algorithmes d'intérêt
public. Il permet de réaliser des calculs généraux tout en fournissant une
explication permettant de comprendre et de documenter ces calculs.
2021-03-17 16:36:26 +00:00
2021-11-05 14:52:37 +00:00
Publicodes est adapté pour modéliser des domaines métiers complexes pouvant être
décomposés en règles élémentaires simples (comme la [législation socio-fiscale ](https://github.com/betagouv/mon-entreprise/tree/master/publicodes ),
[un bilan carbone ](https://github.com/laem/futureco-data/blob/master/co2.yaml ),
un estimateur de rendement locatif, etc.).
2021-05-12 14:12:14 +00:00
2021-11-05 14:52:37 +00:00
Il permet de générer facilement des simulateurs web interactifs où l'on peut affiner
progressivement le résultat affiché, et d'exposer une documentation du calcul explorable.
2020-06-02 16:37:59 +00:00
2021-11-05 14:52:37 +00:00
## Installation
2020-06-02 16:37:59 +00:00
2021-11-05 14:52:37 +00:00
```
npm install publicodes
```
2020-06-02 16:37:59 +00:00
2021-11-05 14:52:37 +00:00
## Documentation
2020-06-02 16:41:01 +00:00
2021-11-05 14:52:37 +00:00
- [Se lancer ](https://publi.codes/langage/se-lancer )
- [Principes de base ](https://publi.codes/langage/principes-de-base )
- [Bac à sable ](https://publi.codes/studio )
2017-02-10 14:58:39 +00:00
2021-11-05 14:52:37 +00:00
## Projets phares
2017-03-16 18:30:30 +00:00
2021-11-05 14:52:37 +00:00
- ** [mon-entreprise.fr ](https://mon-entreprise.fr/simulateurs )** utilise publicodes
pour spécifier l'ensemble des calculs relatifs à la législation socio-fiscale
en France. Le site permet entre autre de simuler une fiche de paie complète,
de calculer les cotisations sociales pour un indépendant ou encore connaître
le montant du chômage partiel.
- ** [futur.eco ](https://futur.eco/ )** utilise publicodes pour calculer les bilans
carbone d'un grand nombre d'activités, plats, transports ou biens.
- ** [Nos Gestes Climat ](https://ecolab.ademe.fr/apps/climat )** utilise publicodes pour proposer un calculateur d'empreinte climat personnel de référence complètement ouvert