ode-bootstrap 1.0.0-dev-produit.202207251251

package/README.md

@@ -0,0 +1,86 @@
+# ODE Bootsrap Framework
+
+ODE Bootstrap is a CSS framework contains all UI components used by our ENT.
+This framework is based on bootstrap 4.
+
+## Install
+
+Install it by cloning the repository:
+```
+git clone https://github.com/opendigitaleducation/ode-bootstrap.git
+./build.sh clean init
+```
+
+### Start dev mode
+
+Launch it using:
+```
+./build.sh watch
+```
+
+A light web server starts and the URL is displayed on console (http://localhost:8080/docs most of the time).
+Livereload is enable, so each changes on source trigger a refresh in the browser.
+
+### Build release
+
+Build a release using:
+```
+./build.sh build
+```
+
+Minified CSS and assets are generated into *dist* folder.
+
+## Create a theme
+
+The framework is full customisable and lets you create themes.
+
+In your theme, install the dependency using:
+
+```
+npm i --save-dev ode-bootstrap
+```
+
+Then import the sass file below:
+```
+@import "node_modules/ode-bootstrap/scss/index";
+```
+
+And then you can override all variables:
+- defined *node_modules/ode-bootstrap/scss/_variables-ode*
+- defined in bootstrap framework
+
+
+## Linter SCSS
+
+Lancer le linter sur les fichers scss du projet
+```
+./build.sh lint
+```
+
+Lancer le linter sur les fichers scss du projet et corriger certains problèmes de mise en forme
+```
+./build.sh lint-fix
+```
+
+Pour un affichage des problèmes en temps réel, installer le plugin VSC stylelint.
+Pour une correction du formattage à l'enregistrement, ajouter au ficher de configuration settings.json:
+```
+"editor.codeActionsOnSave": {
+    "source.fixAll.stylelint": true
+},
+```
+
+## Documentation
+
+TODO
+Regles de nommage
+
+Ajout d'un composant
+
+Surcharge composant
+
+Ajout d'une variable
+
+Ajout d'une mixin
+
+Ajout d'un icone