@ouds/web

v0.0.3

Published

a month ago

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

Downloads

0High
0Medium
0Low

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

Quick start

Several quick start options are available:

Download the latest release
Clone the repo: git clone https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap.git
Install with npm: npm install @ouds/[email protected]
Install with yarn: yarn add @ouds/[email protected]
Install with Composer: composer require orange-opensource/orange-boosted-bootstrap:dev-ouds/main
Install with NuGet: CSS: Install-Package ouds-web Sass: Install-Package ouds-web.sass

Read the Getting started page for information on the framework contents, templates, examples, and more.

Status

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/
├── 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
└── js/
    ├── ouds-web.bundle.js
    ├── ouds-web.bundle.js.map
    ├── ouds-web.bundle.min.js
    ├── ouds-web.bundle.min.js.map
    ├── ouds-web.esm.js
    ├── ouds-web.esm.js.map
    ├── ouds-web.esm.min.js
    ├── ouds-web.esm.min.js.map
    ├── ouds-web.js
    ├── ouds-web.js.map
    ├── ouds-web.min.js
    └── ouds-web.min.js.map

We provide compiled CSS and JS (ouds-web.*), as well as compiled and minified CSS and JS (ouds-web.min.*). Source maps (ouds-web.*.map) are available for use with certain browsers' developer tools. Bundled JS files (ouds-web.bundle.js and minified ouds-web.bundle.min.js) include Popper.

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 Hugo and publicly hosted on GitHub Pages at https://web.unified-design-system.orange.com/. The docs may also be run locally.

Documentation search is powered by Algolia's DocSearch.

Running documentation locally

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

Learn more about using Hugo by reading its documentation.

Documentation for previous releases

You can find all our previous releases docs on https://web.unified-design-system.orange.com/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.

Creators

Bootstrap

Mark Otto

Jacob Thornton

Thanks

Thanks to BrowserStack for providing the infrastructure that allows us to test in real browsers!

Thanks to Netlify for providing us with Deploy Previews!

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Table of contents