Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dof-dss/nicsdru_origins_theme
A Drupal theme which serves as a good base to sub theme nics sites from
https://github.com/dof-dss/nicsdru_origins_theme
drupal origins
Last synced: 2 months ago
JSON representation
A Drupal theme which serves as a good base to sub theme nics sites from
- Host: GitHub
- URL: https://github.com/dof-dss/nicsdru_origins_theme
- Owner: dof-dss
- License: mit
- Created: 2019-07-18T11:44:31.000Z (over 5 years ago)
- Default Branch: 10.x-dev
- Last Pushed: 2024-09-04T10:08:35.000Z (4 months ago)
- Last Synced: 2024-09-30T07:04:30.014Z (3 months ago)
- Topics: drupal, origins
- Language: SCSS
- Homepage:
- Size: 954 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/dof-dss/nicsdru_origins_theme)
# nicsdru_origins_theme
This repository contains code for a Drupal 8 theme from which NICS sites could be sub-themed from.
## Table of contents
- [Quick start](#quick-start)
- [What's included](#whats-included)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Using the NPM scripts](#using-the-npm-scripts)
- [Sub-theming](#sub-theming)
- [Documentation](#documentation)
## Quick start
- [Download the latest release](https://github.com/dof-dss/nicsdru_origins_theme/archive/master.zip) or clone the repo: `git clone https://github.com/dof-dss/nicsdru_origins_theme.git`.
- `npm install` **NB:** you encounter issues with the image optimisation libraries if you don't have libjpeg library available on the host machine. To fix this `brew install libjpeg`.
## What's included
The theme uses [NPM scripts](https://docs.npmjs.com/misc/scripts) and packages to create tooling to:
* write and compile scss to css
* apply appropriate prefixing for css rules
* write and uglify js
* detect features the user’s browser has to offer (via Modernizr)
* code linting
* optimise and compress images for the web
Within the download you'll find the following directories and files, logically grouping common assets, you'll see something like this:
```
nicsdru_origins_theme/
└── config/
│ ├── install/
│ ├── .sass-lint.yml
│ ├── modernizr-config.json
│ ├── postcss.config.js
└── css/
└── images/
└── js/
└── src/
│ ├── images/
│ ├── js/
│ ├── scss/
│ ├── styleguide/
└── templates/
│ ├── block/
│ ├── content/
│ ├── field/
│ ├── layout/
│ ├── misc/
│ ├── navigation/
│ ├── user/
└── .gitignore
└── composer.json
└── imagemin.js
└── nicsdru-origins-theme.breakpoints.yml
└── nicsdru-origins-theme.info.yml
└── nicsdru-origins-theme.layouts.yml
└── nicsdru-origins-theme.libraries.yml
└── nicsdru-origins-theme.theme
└── package.json
└── README.md
└── screenshot.png
```
## Using the NPM scripts
The `package.json` includes the following commands and tasks:
| Task | Description |
| --- | --- |
| `npm run build` | `npm run build` compiles files into their build directories ready for use in a production environment. **Uses [Sass](https://sass-lang.com/), [Autoprefixer][autoprefixer], [Modernizr](https://modernizr.com) and [UglifyJS](https://github.com/mishoo/UglifyJS2).** |
| `npm run watch` | Watches for changes to scss and js files & compiles them for development purposes.|
| `npm run lint` | Will run all `.scss` and `.js` files through their respective linting tools - [eslint]() & [sass-lint](https://github.com/sasstools/sass-lint), note however that linting is also performed as part of the the build scripts. This is useful for finding issues being flagged by the linting rules. To only lint css or js files, prefix the lint command with the file type you which to scope the linting to eg `npm run css-lint` or `npm run js-lint` |
Run `npm run` to see all the npm scripts.
## Sub-theming
TODO: add in how to sub-theme from this theme.
## Documentation
TODO: add documentation.
[autoprefixer]: https://github.com/postcss/autoprefixer