qpc-github / annuaire-entreprises-site

L’annuaire officiel des Entreprises françaises

Annuaire des Entreprises - [Site web]

Statut des APIs utilisées sur le site :

Pour voir le détail des disponibilités des API utilisées sur le site, consultez la page de statut.

Ce site est disponible en ligne : L’Annuaire des Entreprises

Ce site a pour vocation de mettre à disposition des citoyens et des agents les données ouvertes "Open-data" des entreprises, associations et administrations dotées d'un n° siren/siret.

Architecture du service 🏗

Ce repository fait partie d'un ensemble de services qui constituent l'Annuaire des Entreprises :

Description	Accès
Le site Web	par ici 👉
L’API du Moteur de recherche	par ici 👉
L‘API de redondance de Sirene	par ici 👉
Le traitement permettant la génération de données à ingérer dans le moteur de recherche	par ici 👉
L’API de proxy du RNCS	par ici 👉

A propos des choix d'architecture

Ce site utilise Next.js de manière modifiée :

• en developpement, next.js tourne de manière normale.
• en production, la ré-hydratation de react dans le navigateur est désactivée. Next.js se comporte comme un framework de rendu serveur traditionnel.

Pourquoi désactiver la ré-hydratation ? Par soucis d'inclusivité et de frugalité :

1. Le site peut fonctionner en mode dégradé sans javascript
2. Les pages du site sont beaucoup, beaucoup, beaucoup plus légères, ce qui avec un bon débit donne le même confort qu'une SPA, et avec un mauvais débit est plus utilisable q'une SPA

Dans ce cas pourquoi utiliser Next.js ? Pour bénéficier de l'écosystème, de l'outillage dev (HotReload en local, typescript) et pour des raisons de compétences et de préférences.

Installation

# Installation
npm i

# Lancer le site en dev
npm run dev

# Lancer le site en prod
export PORT=3000
npm run build && npm run start

Tooling Dev Experience

Commitlint

Nous utilisons commitlint pour vérifier que les messages.

Eslint

Afin d'améliorer votre expérience de dev vous pouvez utiliser l'extenstion Eslint.

Ajouter la configuration ci-dessous pour fixer les problèmes de linting automatiquement

  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },

Tests

1. Linter

npm run lint

2. Tests unitaires

npm run test:unit

3. Tests end2end

npm run test:end2end

Deploiement

Le déploiement se fait par Github action

A chaque "merge" sur master :

• Laissez le déploiement se faire automatiquement sur staging via l'action deploy-staging
• Vérifiez vos changements sur staging
• Lancez manuellement le déploiement sur production : sur deploy-production et cliquez sur "Run workflow" -> "Run workflow"

NB: Si plusieurs déploiements sont déclenchés en même temps, seul le premier va jusqu'au bout. Les autres sont automatiquement interrompus.

Sitemap & scripts SEO

Le script SEO est déclenché deux fois par mois par une github action. Il génère :

• un ensemble de sitemaps listant les ~8M d'unite legales (~200 fichiers)
• un arbre de page de resultats statiques avec les ~8M d’UL (~200 000 fichiers)

Les fichiers sont compressés puis stockés dans un artifact et téléchargés lors du déploiement sur les différents environnements.

Le script est dans son propre dossier, avec son propre package.json et sa propre config typescript.

Pour lancer le script :

cd seo-script
npm run build:seo

Licence

Ce projet est sous AGPL 3.0