ode-bootstrap-one 1.1.3 → 1.2.1-dev.202307271011

package/README.md

@@ -1,4 +1,4 @@
-# ODE Bootsrap One
+# ODE Bootsrap ONE
 
 ODE Bootstrap ONE is a theme based on ODE bootstrap framework.
 This theme is customisable through variables, so it is possible to create a new theme based on this one.
@@ -8,46 +8,35 @@ This theme is customisable through variables, so it is possible to create a new
 Install it by cloning the repository:
 ```
 git clone git@code.web-education.net:one/ode-bootstrap-one.git
-./build.sh clean init
+./build.sh clean initDev
 ```
 
-### Start dev mode
+> initDev command will create a symlink with ode-bootstrap
 
-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.
+## Dev
 
-### Build release
+Working with `ode-dev-server`, you can watch the SCSS files to copy them directly in the right folder.
 
-Build a release using:
 ```
-./build.sh install
+yarn watch
 ```
 
-Minified CSS and assets are generated into *dist* folder.
+Working on `ode-react-ui` library, you can watch the SCSS files to copy them inside Storybook folder.
 
-The build will publish the artifact into your local repository
-
-### Deploy in a springboard
-
-Add this configuration to your entcore config:
 ```
-{
-    "name":"com.opendigitaleducation~ode-bootstrap-one~VERSION",
-    "type": "theme",
-    "waitDeploy": true
-},
+yarn watch:react
 ```
 
-## Documentation
+## Components
 
-A documentation listing all available components is available [here](docs/index.html). You can preview all of them and copy source code.
+To override styles we use SCSS and CSS Variables.
 
-Below all variables and their meaning:
+```scss
+// ode-bootstrap-one > _form-control.scss
 
-TODO
+$input-focus-border-color: $orange-200;
 
+.form-control {
+  --#{$prefix}input-focus-border-color: #{$input-focus-border-color};
+}
+```