Skip to content

Commit e0e1323

Browse files
authored
feat: new bootstrap theme and demo application (#46)
BREAKING CHANGE: SCSS files for import are in new locations. See the README to update your scss files. - Semantic release now manages releases - Create-react-app demo site has been added to the project - Massive style and theme update
1 parent 36e06dd commit e0e1323

File tree

132 files changed

+29677
-8195
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+29677
-8195
lines changed

.env

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
PUBLIC_URL=/edx-bootstrap

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
dist
2+
build
13
css
24
samples/edx-bootstrap
35
node_modules
6+
sass/.DS_Store
7+
.DS_Store

.travis.yml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
language: node_js
2-
3-
sudo: false
4-
52
node_js:
6-
- 8
7-
3+
- 8
4+
notifications:
5+
email:
6+
recipients:
7+
8+
on_success: never
9+
on_failure: always
810
install:
9-
- make install
10-
11+
- npm install
1112
script:
12-
- make test
13-
14-
deploy:
15-
provider: npm
16-
17-
api_key:
18-
secure: Wsa+BAaxJPrfwliMJVP4TJ7KvNtoMVSYJv82lZeeRUahgDoNWBWHN/S+VkdORh7kVfkxEzEyLux9TxMQfYcT5b2Ov7hXna/vFqRWmI9F2M16oRTu8Gc6xaErg1q/Xv80pQlBewjg1eeE5RuC/f1Lfylh7mJXpUbBa0YUqRRPWAE+td0P6KZrr7PlbzOVX2E6P806ZzF5REbCWedncq34MnexqTBDS3qXmdF+KRK6uPmNT/4ASEtqxXTeQKv+MGH3RZCTxF1T/fb62PhuPYBOsrOKQHUAUp7Q5tGvOKt3CrcwBNckFbJzLM5MD6G0JYLM7fJGhCYl6ZWb7xOdwp3Hh1zsqO/utHb2wkvifaiXap1KBr2yP/gC/FVyL80PnDe5AjiAyrQbUzbiohtlwjHQt8j3/O53lDeLn1A5Z5XYBoDIyGwOIOV/9SRygoy88+dGsqkLvvI8vsiSDOi/eXxoNV1ufLK8gtpBXMclYFo0cUTQa40vtyu4UepKZevT+poLNdEiaFdSXyo30DDTOsX85XkwliBHUy7USmVdp804wF+4MNkxjcR+nSesq4ZJpkm4iDZSItmBL/qFr7ZNbb1MQRgKLWMVuJhHkJ82zntYGXaNJKjsbNhzpoLXAI8o49uhIGopNQjU+PJAzxUQH4ZhoW3iW0Bc38u7UvRkONQLuEQ=
19-
on:
20-
tags: true
21-
all_branches: true
13+
- npm run lint
14+
- npm run build
15+
after_success:
16+
- npm run semantic-release
17+
env:
18+
global:
19+
- secure: npInmf7b8/XckJ7tv7PnOw7zNzEKQYSJvOa+YIC+B6l0kIl7xYqYnOZUOblBuHoCxbPLXU0ErtwtF6hR7tYkZXvMCM++73X7C2IKA/VbMfbKa8/z5AkgnIb13dhuWv0ciHzuhThq39eB4UJtUIOXKxKoxEbfuidi1vaoS76PJI9Cq93WUZS8aIwgyZdhqI2j4O6s5DqVmemXmL/BCvMkNS0ok/x8O/WTqaY6v7XPzenQIKIs0OBbU3QEpTwusBud9BpninJKSKHiqBWbay0Rt1f+RhcEcR7Dwd8IK8sF524SRE1q6lCZNJmlBKnVhuYi0rT58iXK7bRVeZBAm3X5aKjLdL8aRk1t4N2r8MMz0BDGmgGj+sA3Ezy/to9Se3LLi3Vr/5huWB3xdvMY1Y182ByMFEgxLX8bOeC8Tnk60i6Pi6QaiHkyBAiugGmXsktEOdLK3XCM9FJAemhtBsb4dlhacnaS1jFWpexjmsq73ku2mgUqt48mtwu0BmC3340ewfM2S+b8e2xKw1v1JvE1cMqITOWvSqtHIZFRPpY+U1HjEVgoLA7slPDq+G14NO10MckPESBQum4QtZlE+qh0FlHtI0zWd5uSmGLsDxGs6Dk8OyXknzec1bM7LWMwuNuJyQdEB1RqwNi1UYo0lRfJ4l9HEmszZxXwmySJ92awaMg=
20+
- secure: mcaptZElUzMCyzo2ll4lRmcuCbqN+S/rLU0AkM3IxAw40dbPI1fFtGtKZA5EIgCu+S8MX06fzlJ15eF8vWP1d/kAUp6hBws4c9yF5M3PGhKqPSZLys5lLGq4+sWv6IyU/X9WaWiQsvt8BomnKlWhlQu0Po5f0ckDVo/36A69cxUSvII9sGZsJC82CoaaP/6672QlxXXOBepCD+OtIrQq2PGU4W41YX2uhVIxGbdxdKj/+KWbO63rdrbKcVH2gVB7NKtLHEcCDD+7GKn1yH+C6KINaa3cDZQo3q91Cv7RcjvdOL1L+j5dmiVmZRNX1QngVMGRcgsdWHhs8L/5B39e1ksnes60eeQtL6u5RhNyAylyvfN/cVaCC+DRYwpr9SFPQ51YK40BKULC7fueSOXMR1OGRXNEjRaL694vJ7KjCg4GOuxf+DZcFyABQvABcUEwKj4ayn/vWCUSyTly0VgSOxxQLtqj5WObj3asrsCAwQUJ0jAXsFP7WAAzJSheb5R1kHAkTtqp4gcn8miuujCEp4kMw6YfvmwWUb5ZrSP72QxQ3retdrPfokaThcfxfGFnzfVCOoD4DEaWTxLbPKyPcYYnpskfgEmbHiR44qEfUL/lAqBncqUgo4A02GUpCajPzOqA1vpvfE9DT8oMw4Kk37SIAKNao225EgBU3j45qDM=

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

Makefile

Lines changed: 0 additions & 44 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

README.rst

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
.. image:: https://badge.fury.io/js/%40edx%2Fedx-bootstrap.svg
2+
:target: https://badge.fury.io/js/%40edx%2Fedx-bootstrap
3+
.. highlight:: css
4+
5+
=============
6+
edX Bootstrap
7+
=============
8+
9+
This library is an extension of `Bootstrap 4 <http://getbootstrap.com>`_
10+
for use with edX and openEdX.
11+
12+
Installation
13+
------------
14+
15+
Using npm::
16+
17+
npm install --save @edx/edx-bootstrap
18+
19+
Usage
20+
-----
21+
22+
Add the following import in your project's base scss file::
23+
24+
@import "~@edx/edx-bootstrap/scss/edx/theme.scss";
25+
26+
Or for Open edX users::
27+
28+
@import "~@edx/edx-bootstrap/scss/open-edx/theme.scss";
29+
30+
This includes everything you need. Bootstrap is included so you don't
31+
need to add it in your project. If you need more control, see the
32+
theming section.
33+
34+
Alternatively, you can download this repo and use one of the compiled outputs:
35+
36+
- ``dist/open-edx/theme.css`` (Open edX bootstrap, extensions, & theme)
37+
- ``dist/edx/theme.css`` (edX bootstrap, extensions, & theme)
38+
- ``dist/core/core.css`` (edX bootstrap & extensions only)
39+
40+
Theming
41+
-------
42+
43+
The content of a `theme.scss` file::
44+
45+
// Optional
46+
@import "my-fonts";
47+
@import "my-variables";
48+
49+
// Required core (includes bootstrap and extensions)
50+
@import "@edx/edx-boostrap/scss/core/core.scss";
51+
52+
// The rest of your scss
53+
// ...
54+
55+
To create a theme, make a copy of the ``scss/open-edx`` folder in your own project
56+
and make changes. Then include it before you include edx-bootstrap::
57+
58+
@import "fonts";
59+
@import "variables";
60+
61+
// If you are creating your own theme remove
62+
// the "../core/core" import with the line below.
63+
@import "../core/core";
64+
// @import "@edx/edx-boostrap/scss/core/core.scss";
65+
66+
@import "overrides";
67+
68+
Getting Help
69+
------------
70+
If you’re having trouble, contact the arch squad on Slack:
71+
72+
- `#front-end <https://openedx.slack.com/messages/C0EUBSV7D>`_
73+
- `#architecture <https://openedx.slack.com/messages/C0RU5BTCP>`_
74+
- edX Internal: #arch-team
75+
76+
License
77+
-------
78+
79+
The code in this repository uses the Apache 2.0 license unless otherwise noted.
80+
Please see the `LICENSE file <https://github.com/edx/edx-bootstrap/blob/master/LICENSE>`_
81+
for details.
82+
83+
Documentation
84+
-------------
85+
86+
Documentation details can be found in the `docs index.rst`_.
87+
88+
.. _docs index.rst: docs/index.rst
89+
90+
91+
How to Contribute
92+
-----------------
93+
94+
Contributions are very welcome, but for legal reasons, you must submit a
95+
signed `individual contributor agreement`_ before we can accept your
96+
contribution. See our `CONTRIBUTING`_ file for more information – it
97+
also contains guidelines for how to maintain high code quality, which
98+
will make your contribution more likely to be accepted.
99+
100+
101+
Reporting Security Issues
102+
-------------------------
103+
104+
Please do not report security issues in public. Please email
105+
106+
107+
.. _individual contributor agreement: https://open.edx.org/wp-content/uploads/2019/01/individual-contributor-agreement.pdf
108+
.. _CONTRIBUTING: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst

commitlint.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-angular'],
3+
};

0 commit comments

Comments
 (0)