Giter Site home page Giter Site logo

lccgov / lcc_templates Goto Github PK

View Code? Open in Web Editor NEW
1.0 6.0 1.0 569 KB

Contains the LCC overarching HTML design structure (master pages) and page templates (page layouts) and outputs them into a variety of mark-up formats.

License: MIT License

JavaScript 74.19% HTML 25.69% CSS 0.11%

lcc_templates's Introduction

lcc templates

A collection of templates to be used by Leeds City Council applications..

The compilation and packaging model is based on govuk_template, but ported to Node.js rather than using Ruby.

It contains our overarching HTML design structure (master pages) and a number of page templates (page layouts). They only contain plain HTML and EJS (Effective JavaScript) placeholders at this point, with no reference to any server-side technology such as ASP.NET server controls.

The build process, using Jake processes each of the templates and currently outputs them in two formats:

This process could be extended to any markup language, such as Razor by creating a new processor in the build/compiler directory of the repo and a new publisher in the build/publisher directory.

We also include JavaScript that is fundamental for the working of all our templates/sites. We have a selection of modules located in source/assets/javascripts/modules directory that allow designers/content editors to add interaction by simply adding data attributes to HTML elements, such as data-module='carousel' for example. If you think that the piece of functionality that you are developing would be beneficial to many LCC applications, then it would be worthwhile including it in this repo..

The benefit of using this approach for creating our templates is that we are not tied into a specific vendor/technology, so if we do need to swap our CMS in the future it should be trivial to re-apply our LCC branding.

If you need to create/update a template or add/update any assets, the following steps need to be carried out:

  1. Update or create a template in source/views directory or add the new asset to the relevant subdirectory under source/assets.
  2. Bump version in package.json โ€“ we use semantic versioning. NOTE: If this step is omitted, then when you commit and push your changes it will not generate new NPM packages for each of the output formats. Helpful when you are not ready to publish a new package but want to make sure your changes are source controlled.
  3. Commit changes and push to remote repository.
  4. Once pushed, a Travis CI build is kicked off that checks that the version has increased and if so pushes the changes to the specific mark-up format GitHub repositories, lcc_templates_nunjucks and lcc_templates_sharepoint. Once the changes have been pushed, they are then published to the NPM registry.

The current NPM packages that are generated from this repo:

lcc_templates's People

Contributors

lccgov avatar rodmiley avatar nidge avatar kellyclarksonlcc avatar fullycoded avatar paulmac66 avatar davidhunter08 avatar dafunkphenomenon avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar  avatar  avatar  avatar  avatar

Forkers

madenorth

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.