Merge pull request #1 from edx/andya/bootstrap-theme

First version of the edX Bootstrap theme

Author: andy-armstrong

.gitignore

@@ -0,0 +1,3 @@
+css
+samples/edx-bootstrap
+node_modules

.npmignore

@@ -0,0 +1,9 @@
+.edx-bootstrap
+.gitignore
+.npmignore
+.travis.yml
+_config.yml
+doc
+node_modules
+package.json
+test

Makefile

@@ -0,0 +1,37 @@
+.PHONY: clean docs help install preview quality samples test
+
+.DEFAULT_GOAL := help
+
+help: ## display this help message
+	@echo "Please use \`make <target>' where <target> is one of"
+	@perl -nle'print $& if m{^[a-zA-Z_-]+:.*?## .*$$}' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'
+
+install: ## install requirements
+	npm install
+
+clean: ## remove build artifacts
+	rm -rf css/
+	rm -rf samples/css/
+	rm -rf samples/edx-bootstrap/
+
+samples: clean ## build the samples
+	mkdir samples/edx-bootstrap
+	cp -r fonts/ samples/edx-bootstrap/fonts
+	cp -r sass/ samples/edx-bootstrap/sass
+	mkdir samples/css
+	mkdir samples/css/edx
+	mkdir samples/css/open-edx
+	./node_modules/node-sass/bin/node-sass samples/edx/sass --output samples/edx/css --include-path samples --include-path node_modules
+	./node_modules/node-sass/bin/node-sass samples/open-edx/sass --output samples/open-edx/css --include-path samples --include-path node_modules
+
+build: clean ## build the npm package
+
+preview: samples ## build the preview site
+	aws s3 sync samples s3://${S3_PREVIEW_DOMAIN}/$(shell git rev-parse --abbrev-ref HEAD)
+	@echo Preview generated to http://${S3_PREVIEW_DOMAIN}/$(shell git rev-parse --abbrev-ref HEAD)
+
+test: clean samples ## run tests
+
+xxx:
+	echo $(shell git rev-parse --abbrev-ref HEAD)
+

README.md

@@ -0,0 +1,67 @@
+EdX Bootstrap
+=============
+
+This library provides `Bootstrap 4`_ themes for use within Open edX. It
+includes an Open edX theme as well as an edX-branded theme. In addition,
+it includes the `Open Sans typeface`_ which is the default font for Open edX.
+
+.. _Bootstrap 4: https://v4-alpha.getbootstrap.com/
+.. _Open Sans typeface: https://fonts.google.com/specimen/Open+Sans
+
+Getting Started
+---------------
+
+The edx-bootstrap library should be installed via npm:
+
+    npm install edx-bootstrap
+
+Once installed, you can generate the `Sample pages`_:
+
+    make samples
+
+For a full list of the available make targets, run:
+
+    make help
+
+.. sample pages: https://github.com/edx/edx-bootstrap/blob/master/samples
+
+Using The EdX Bootstrap Theme
+-----------------------------
+
+To use an edX Bootstrap theme, import the ``_theme.scss`` partial file from
+your chosen theme into your own Sass. Note that this file must be loaded before
+any Bootstrap partial files so that the theming will be applied.
+
+See the `sample Open edX SASS file`_ for a simple example.
+
+.. sample Open edX SASS file: https://github.com/edx/edx-bootstrap/blob/master/samples/open-edx/sass/sample.scss
+
+License
+-------
+
+The code in this repository is licensed under version 3 of the AGPL
+unless otherwise noted. Please see the `LICENSE`_ file for details.
+
+.. _LICENSE: https://github.com/edx/edx-bootstrap/blob/master/LICENSE
+
+How To Contribute
+-----------------
+
+Contributions are very welcome. Please read `How To Contribute`_ for details.
+Even though they were written with ``edx-platform`` in mind, the guidelines
+should be followed for Open edX code in general.
+
+.. _How To Contribute: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst
+
+Reporting Security Issues
+-------------------------
+
+Please do not report security issues in public. Please email security@edx.org.
+
+Getting Help
+------------
+
+Have a question about this repository, or about Open edX in general?  Please
+refer to this `list of resources`_ if you need any assistance.
+
+.. _list of resources: https://open.edx.org/getting-help