UNPKG

5.78 kBMarkdownView Raw
1[![GitHub issues](https://img.shields.io/github/issues/italia/bootstrap-italia.svg)](https://github.com/italia/bootstrap-italia/issues)
2[![Join the #design channel](https://img.shields.io/badge/Slack%20channel-%23design-blue.svg)](https://developersitalia.slack.com/messages/C7VPAUVB3/)
3[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
4
5# Bootstrap Italia [![Version](https://img.shields.io/github/release/italia/bootstrap-italia.svg)](https://github.com/italia/bootstrap-italia/releases) [![CircleCI](https://circleci.com/gh/italia/bootstrap-italia/tree/master.svg?style=svg)](https://circleci.com/gh/italia/bootstrap-italia/tree/master)
6
7*Read this in other languages: [Italiano](README.md).*
8
9Bootstrap Italia is a [Bootstrap 4](https://getbootstrap.com/docs/) theme to create responsive web apps to make Italian public digital services consistent, accessible and simple to use.
10
11Bootstrap Italia inherits components, mixins, grid system, and anything else from Bootstrap 4, customising them accordingly to the [Italian guidelines for designing public digital services](https://docs.italia.it/italia/designers-italia/design-linee-guida-docs/).
12
13**[Check out the documentation »](https://italia.github.io/bootstrap-italia/)** (in italian)
14
15or
16
17**[Download the latest version of the library »](https://github.com/italia/bootstrap-italia/releases)**
18
19## Indice
20
21- [Getting started](#getting-started)
22- [Issues and requests](#issues-and-requests)
23- [How to contribute](#how-to-contribute)
24- [Third-party licenses](#third-party-licenses)
25
26## Getting started
27
28To start playing with Bootstrap Italia, you can unzip the library and add the files to your project, as described [here](https://translate.google.it/translate?hl=it&sl=it&tl=en&u=https%3A%2F%2Fitalia.github.io%2Fbootstrap-italia%2Fdocs%2Fcome-iniziare%2Fintroduzione%2F) (automatic translation by Google Translate).
29
30## Issues and requests
31
32Found a bug or asking for help?
33
34First of all, please ensure you're trying to tackle a problem with the Bootstrap Italia theme and not with the Bootstrap library itself (in that case you can refer directly to [Bootstrap repository](https://github.com/twbs/bootstrap)), then
35you can [create an issue](https://github.com/italia/bootstrap-italia/issues).
36
37## How to contribute
38
39Would you like to help with Bootstrap Italia? **You are in the right place!**
40
41If you have not already done so, start by spending a few minutes to deepen your knowledge on [design guidelines for Italian public digital services](https://docs.italia.it/italia/designers-italia/design-linee-guida-docs/) (in italian), and refer to the [instructions on how to contribute to Bootstrap Italia](https://github.com/italia/bootstrap-italia/blob/master/CONTRIBUTING.md) (in italian).
42
43At this point, you'll need to configure the local environment to compile the source files and generate them
44of the documentation. You can find all the information necessary for this purpose at the [page related to the compilation tools](https://translate.google.it/translate?hl=it&sl=it&tl=en&u=https%3A%2F%2Fitalia.github.io%2Fbootstrap-italia%2Fdocs%2Fcome-iniziare%2Fstrumenti-di-compilazione%2F) (automatic translation by Google Translate).
45
46## Third-party licenses
47
48### Components distributed by Bootstrap Italia
49
50Software components distributed with Bootstrap Italia that have their own different license from CC0 are listed below.
51
52- [jQuery](https://jquery.com/) © jQuery Foundation, MIT
53- [Popper.js](https://popper.js.org/) © Federico Zivolo and contributors, MIT
54- [Bootstrap 4](https://getbootstrap.com/) © Twitter, Inc., MIT
55- [Bootstrap Select](https://developer.snapappointments.com/bootstrap-select/) © SnapAppointments, LLC, MIT
56- [Owl Carousel 2](https://owlcarousel2.github.io/OwlCarousel2/) © Owl (David Deutsch), MIT
57- [jQuery Easing](http://gsgd.co.uk/sandbox/jquery/easing/) © George McGinley Smith, BSD
58
59### Main dependencies for the compilation and development phase
60
61- [Jekyll](https://jekyllrb.com), © Tom Preston-Werner and Jekyll contributors, licenza MIT
62- [HTML-proofer](https://github.com/gjtorikian/html-proofer), © Garen Torikian, licenza MIT
63- [Browser Sync](https://www.browsersync.io/) Apache License Version 2.0
64- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/) © conventional-changelog team, ISC License
65- [GulpJS](https://gulpjs.com/), © Blaine Bublitz, Eric Schoffstall and other contributors, licenza MIT
66- [Babel](https://babeljs.io/), © Sebastian McKenzie, licenza MIT
67- [Prettier](https://prettier.io/), © James Long and contributors, licenza MIT
68- [node-sass](https://github.com/sass/node-sass/), © Andrew Nesbitt, licenza MIT
69- [Octokit rest.js](https://octokit.github.io/rest.js/) © 2012 Cloud9 IDE, Inc. (Mike de Boer), 2017-2018 Octokit contributors, licenza MIT
70
71Bootstrap Italia is **BSD 3-Clause** licensed:
72
73[![License](https://img.shields.io/github/license/italia/bootstrap-italia.svg)](https://github.com/italia/bootstrap-italia/blob/master/LICENSE)
74
75<a href="https://www.browserstack.com/
76" target="_blank"><img src="https://p14.zdusercontent.com/attachment/1015988/Acl6uTyvwHnAmpEiRm9p8eh1R?token=eyJhbGciOiJkaXIiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0..ewB9aVdbiHzfkiZdbgrc2Q.s1B7FuA_Wdegrj1PBZ0pVGgjWhzuJD8yTKRptv2BxFNe-KQSsaVtbkBer5X2rNq81mHZ_kEuAOigMPjgorAAzTUA5AmP_OX4JQJdQk96Vg3UggORRd4UDSdS-tF4o4evvo_8f3cciZcBBiFuqm-GXAclqWRusZxHITpEM7OHNvvMSDV35zbOO0zLwTnHKNQL715Ozitqrx_Q94yYO9NUM-h6jrN76MM5hLdM2umQXsrd0JH5EMp7tp8yDAAyNtoqZUiNFxCh0o1dUAFgZodntaLkGOv4Gzzj5kb7iBWS6JY.Ev5PtLdgCYcC4799H6-GEg"
77alt="BrowserStack logo" width="200" height="105" /></a>
78
79We are using BrowserStack for interactive cross browser testing. They are sponsoring our open source project!