@csdsesystems/central-styles 0.1.0 → 1.0.2

package/Gulpfile.js

@@ -0,0 +1,56 @@
+"use strict";
+
+const gulp = require("gulp");
+const sass = require("gulp-sass")(require("sass"));
+const sourcemaps = require("gulp-sourcemaps");
+const hologram = require("gulp-hologram");
+
+const { series, parallel, watch } = gulp;
+
+// Sass
+function buildSass() {
+  return gulp
+    .src("sass/**/*.scss")
+    .pipe(sourcemaps.init())
+    .pipe(sass({ outputStyle: "compressed" }).on("error", sass.logError))
+    .pipe(sourcemaps.write())
+    .pipe(gulp.dest("css"));
+}
+
+// Images
+function images() {
+  return gulp
+    .src("images/**/*")
+    .pipe(gulp.dest("css/images"));
+}
+
+// Hologram
+function buildHologram() {
+  return gulp
+    .src("hologram_config.yml")
+    .pipe(hologram({ logging: true }));
+}
+
+// Watchers
+function watchSass() {
+  watch("sass/**/*.scss", series(buildSass, buildHologram));
+}
+
+function watchHologram() {
+  watch("sass/**/*.md", buildHologram);
+}
+
+// Composite tasks
+const build = parallel(buildSass, images);
+const dev = series(
+  build,
+  buildHologram,
+  parallel(watchSass, watchHologram)
+);
+
+// Exports (Gulp 4 style)
+exports.sass = buildSass;
+exports.images = images;
+exports.hologram = buildHologram;
+exports.build = build;
+exports.default = dev;

package/README.md

@@ -0,0 +1,41 @@
+# Concrete - A living style guide for Central
+
+## Introduction
+Central is an enterprise application developed by the [Clinical Skills Development Service (CSDS)](https://www.sdc.qld.edu.au) to manage delivery of healthcare training and education. Central supports CSDS's ongoing commitment to improving learning solutions for education providers to that enhance the education of clinicians, improve clinical service delivery, and contribute to better clinical outcomes for patients.
+
+## Concrete
+
+Concrete is a design system reflects the components and patterns that underpin Central. The system provides a unified language and consistent feel when designing modules within Central.
+
+### Overview
+
+At present, Concrete serves two purposes. It's a repository for common user interface elements and patterns across Central. It is also a usable tool which can be used and incorporated in to any project that wants to branch off from what we have done here.
+
+Concrete is Central's internal CSS framework.It includes basic global styling for typography, small components like buttons and tabs, and our general guidelines for writing HTML and CSS. It's currently being used in the Equipment section of Central.
+
+Concrete is based on the [Bootstrap Framework](http://getbootstrap.com) and the [Inspinia Responsive Admin Theme](https://wrapbootstrap.com/theme/inspinia-responsive-admin-theme-WB0R5L90S).
+
+## How to install and compile
+
+**Quick build**
+```sh
+npm install
+npm start
+```
+
+**Setup**
+```sh
+npm install
+npm install -g gulp
+```
+
+**Compile and watch**
+```sh
+gulp
+```
+
+## Contact
+
+Questions, thoughts? Please send us an email at support@sdc.qld.edu.au.
+
+*As is the nature of all living style guides, this is a perpetual work in progress* 😄 .

package/css/.gitignore

@@ -0,0 +1,3 @@
+*
+!*.png
+!.gitignore

package/dependencies/.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

package/dependencies/.jshintrc

@@ -0,0 +1,24 @@
+{
+  "node": true,
+  "browser": true,
+  "esnext": true,
+  "bitwise": true,
+  "camelcase": true,
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "indent": 2,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "quotmark": "single",
+  "regexp": true,
+  "undef": true,
+  "unused": true,
+  "strict": true,
+  "trailing": true,
+  "smarttabs": true,
+  "globals": {
+    "$": false
+  }
+}

package/dependencies/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Puzzle ITC GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/dependencies/README.md

@@ -0,0 +1,80 @@
+# Hologram Github Theme
+
+This is a very simple [Github Styleguide](https://github.com/styleguide) inspired theme for Trulia's [Hologram](https://github.com/trulia/hologram), the ruby front-end doc generator.
+
+## Preview
+
+![Example](example.png?raw=true)
+
+[Visit example styleguide](http://wearecube.github.io/hologram-github-theme-example/styleguide)
+
+## Usage
+
+Install Hologram:
+
+```
+$ gem install hologram
+```
+
+Add this theme to your project using NPM:
+
+```
+$ npm install --save-dev hologram-github-theme
+```
+
+Alternatively you may use Bower:
+
+```
+$ bower install --save-dev hologram-github-theme
+```
+
+Define the theme in your `hologram_config.yml`:
+
+```
+# Relative path(s) to your source files
+source: app/styles
+
+# Relative path where you want the documentation to be built
+destination: styleguide
+
+# The path that contains supporting assets for the documentation page
+documentation_assets: node_modules/hologram-github-theme
+
+# Category that will be used as the index.html (optional)
+index: styleguide
+
+# A list of relative paths to folders containing any dependencies to copy
+dependencies:
+  - 'dist'
+
+# The CSS files to be included in the styleguide
+css_include:
+  - 'dist/styles/vendor.css'
+  - 'dist/styles/main.css'
+
+# The JavaScript files to included in the styleguide
+js_include:
+  - 'dist/scripts/main.js'
+
+# The global title that is displayed at the top of the pages
+global_title: Styleguide
+
+```
+
+In this example the markdown file `app/styles/styleguide.md` is used for the content on the index page. Also, if you're using Bower, adjust the package path accordingly: ```documentation_assets: bower_components/hologram-github-theme```.
+
+For more details on the options, checkout the [Hologram documentation](https://github.com/trulia/hologram/blob/master/README.md#creating-a-yaml-config-file)
+
+Finally, build the styleguide:
+
+```
+hologram -c hologram_config.yml
+```
+
+## Authors
+
+The Hologram Github Theme has been created by [Mathis Hofer](https://github.com/hupf). Many thanks to [Maurice Kühlborn](https://github.com/minimalweb) and [Oscar](https://github.com/obartra) for their contributions.
+
+## License
+
+The Hologram Github Theme is licensed under the [MIT License](LICENSE)

package/dependencies/bower.json

@@ -0,0 +1,24 @@
+{
+  "name": "hologram-github-theme",
+  "version": "0.1.4",
+  "authors": [
+    "Mathis Hofer <hofer@puzzle.ch>"
+  ],
+  "description": "A Github Styleguide inspired theme for Hologram",
+  "keywords": [
+    "hologram",
+    "theme",
+    "github",
+    "styleguide"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/wearecube/hologram-github-theme",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests",
+    "example.png"
+  ]
+}