@ouds/web-orange

v1.0.0

Published

23 days ago

OUDS Web Orange is a Bootstrap based, Orange branded accessible and ergonomic components library.

0High
0Medium
0Low

css sass mobile-first responsive front-end framework web bootstrap Orange

Quick start

This package is not intended to be used alone. Please read our main README to know more.

What’s included

Within the download you’ll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.

@ouds/
└── web-orange/
    └── dist/
        └── css/
            ├── ouds-web-bootstrap.css
            ├── ouds-web-bootstrap.css.map
            ├── ouds-web-bootstrap.min.css
            ├── ouds-web-bootstrap.min.css.map
            ├── ouds-web-bootstrap.rtl.css
            ├── ouds-web-bootstrap.rtl.css.map
            ├── ouds-web-bootstrap.rtl.min.css
            ├── ouds-web-bootstrap.rtl.min.css.map
            ├── ouds-web-grid.css
            ├── ouds-web-grid.css.map
            ├── ouds-web-grid.min.css
            ├── ouds-web-grid.min.css.map
            ├── ouds-web-grid.rtl.css
            ├── ouds-web-grid.rtl.css.map
            ├── ouds-web-grid.rtl.min.css
            ├── ouds-web-grid.rtl.min.css.map
            ├── ouds-web-reboot.css
            ├── ouds-web-reboot.css.map
            ├── ouds-web-reboot.min.css
            ├── ouds-web-reboot.min.css.map
            ├── ouds-web-reboot.rtl.css
            ├── ouds-web-reboot.rtl.css.map
            ├── ouds-web-reboot.rtl.min.css
            ├── ouds-web-reboot.rtl.min.css.map
            ├── ouds-web-utilities.css
            ├── ouds-web-utilities.css.map
            ├── ouds-web-utilities.min.css
            ├── ouds-web-utilities.min.css.map
            ├── ouds-web-utilities.rtl.css
            ├── ouds-web-utilities.rtl.css.map
            ├── ouds-web-utilities.rtl.min.css
            ├── ouds-web-utilities.rtl.min.css.map
            ├── ouds-web.css
            ├── ouds-web.css.map
            ├── ouds-web.min.css
            ├── ouds-web.min.css.map
            ├── ouds-web.rtl.css
            ├── ouds-web.rtl.css.map
            ├── ouds-web.rtl.min.css
            └── ouds-web.rtl.min.css.map

We provide compiled CSS (ouds-web.*), as well as compiled and minified CSS (ouds-web.min.*). Source maps (ouds-web.*.map) are available for use with certain browsers’ developer tools.

We also provide a compiled and minified CSS (ouds-web-bootstrap.* and ouds-web-bootstrap.min.*) enforcing Bootstrap compatibility.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

OUDS Web’s documentation, included in this repo in the root directory, is built with Astro and publicly hosted on GitHub Pages at https://web.unified-design-system.orange.com/orange/. The docs may also be run locally.

Documentation search is powered by Algolia’s DocSearch.

Running documentation locally

Run npm install from the root /ouds-web directory, to install the Node.js dependencies, including Astro (the site builder).
Run npm run css from the brand root /ouds-web/packages/orange directory, (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
From the root /ouds-web/packages/orange directory, run npm run astro-dev in the command line.
Open http://localhost:9001/orange/ in your browser, and voilà.

Learn more about using Astro by reading its documentation.

Documentation for previous releases

You can find all our previous releases docs on https://web.unified-design-system.orange.com/orange/docs/versions/.

Previous releases and their documentation are also available for download.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, OUDS Web is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of OUDS Web.

Our default branch is for development of our OUDS Web release.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Table of contents