Voir sur GitHub

Outils de construction

Apprenez à utiliser les scripts npm inclus de Bootstrap Table pour construire notre documentation, compiler le code source, et plus encore.

Sur cette page

Configuration des outils

Bootstrap Table utilise des scripts NPM pour son système de construction. Notre package.json inclut des méthodes pratiques pour travailler avec le framework, y compris la vérification du code, la compilation du code, et plus encore.

Pour utiliser notre système de construction et exécuter notre documentation localement, vous aurez besoin d’une copie des fichiers source de Bootstrap Table et de Node. Suivez ces étapes, et vous devriez être prêt à partir :

  1. Téléchargez et installez Node.js, que nous utilisons pour gérer nos dépendances.
  2. Naviguez vers le répertoire racine /bootstrap-table et exécutez npm install pour installer nos dépendances locales répertoriées dans package.json.
  3. (Seulement pour le site de documentation) Si vous souhaitez configurer le site de documentation, naviguez vers le répertoire /site et exécutez npm install pour installer Astro et d’autres dépendances pour le site de documentation.

Une fois terminé, vous pourrez exécuter les diverses commandes fournies à partir de la ligne de commande.

Utilisation des scripts NPM

Notre package.json inclut les commandes et tâches suivantes :

TâcheDescription
npm run buildnpm run build crée le répertoire /dist avec les fichiers compilés.
npm run lintVérifie le CSS et JavaScript du répertoire /src.
npm run testExécute la suite de tests du projet.

Exécutez npm run pour voir tous les scripts npm.

Documentation locale

L’exécution de notre documentation localement nécessite l’utilisation d’Astro, un générateur de site statique moderne qui nous fournit : une architecture basée sur les composants, des fichiers basés sur Markdown, des modèles, et plus encore. Voici comment le démarrer :

  1. Passez par la configuration des outils ci-dessus pour installer Astro et d’autres dépendances.
  2. Naviguez vers le répertoire /site et exécutez npm run dev dans la ligne de commande.
  3. Ouvrez http://localhost:4321 dans votre navigateur pour voir le site de documentation local.

En savoir plus sur l’utilisation d’Astro en lisant sa documentation.

Dépannage

Si vous rencontrez des problèmes lors de l’installation des dépendances, désinstallez toutes les versions précédentes des dépendances (globales et locales). Ensuite, réexécutez npm install.