{"id":15138713,"url":"https://github.com/lotustm/kotsu","last_synced_at":"2025-09-29T08:31:14.070Z","repository":{"id":18050427,"uuid":"21101152","full_name":"LotusTM/Kotsu","owner":"LotusTM","description":":sparkles: Clean, opinionated foundation for new projects — to boldly go where no man has gone before","archived":true,"fork":false,"pushed_at":"2020-05-30T23:20:15.000Z","size":4702,"stargazers_count":50,"open_issues_count":66,"forks_count":2,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-19T20:11:25.754Z","etag":null,"topics":["boilerplate","build","continuous-delivery","continuous-deployment","docker","es2015","es6","generator","gettext","grunt","i18n","javascript","jspm","l10n","nunjucks","sass","static-site","static-site-generator","template","website"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LotusTM.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-22T18:19:16.000Z","updated_at":"2024-05-20T23:08:07.000Z","dependencies_parsed_at":"2022-08-27T16:31:21.090Z","dependency_job_id":null,"html_url":"https://github.com/LotusTM/Kotsu","commit_stats":null,"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LotusTM%2FKotsu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LotusTM%2FKotsu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LotusTM%2FKotsu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LotusTM%2FKotsu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LotusTM","download_url":"https://codeload.github.com/LotusTM/Kotsu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234604461,"owners_count":18859164,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","build","continuous-delivery","continuous-deployment","docker","es2015","es6","generator","gettext","grunt","i18n","javascript","jspm","l10n","nunjucks","sass","static-site","static-site-generator","template","website"],"created_at":"2024-09-26T07:43:51.740Z","updated_at":"2025-09-29T08:31:13.539Z","avatar_url":"https://github.com/LotusTM.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Kotsu](https://cloud.githubusercontent.com/assets/4460311/23858130/1da87904-0808-11e7-9748-9f56fb8a55e0.png)\n\n\u003cdiv align='center'\u003e\n  \u003ch3\u003eAdvanced Web Starter Kit\u003c/h3\u003e\n  \u003cp\u003eTo boldly go where no man has gone before\u003c/p\u003e\n\u003c/div\u003e\n\n---\n\n\u003cp align='center'\u003e\n  \u003ca href='https://www.npmjs.com/package/kotsu'\u003e\n    \u003cimg src='https://img.shields.io/npm/v/kotsu.svg' alt='NPM version' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://travis-ci.org/LotusTM/Kotsu'\u003e\n    \u003cimg src='https://img.shields.io/travis/LotusTM/Kotsu/master.svg?label=travis' alt='Travis Build Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://circleci.com/gh/LotusTM/Kotsu'\u003e\n    \u003cimg src='https://img.shields.io/circleci/project/LotusTM/Kotsu/master.svg?label=circle' alt='CircleCI Build Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://ci.appveyor.com/project/LotusTM/Kotsu'\u003e\n    \u003cimg src='https://img.shields.io/appveyor/ci/LotusTM/Kotsu/master.svg?label=appveyor' alt='AppVeyor Build Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://greenkeeper.io'\u003e\n    \u003cimg src='https://badges.greenkeeper.io/LotusTM/Kotsu.svg' alt='Greenkeeper Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://david-dm.org/LotusTM/Kotsu'\u003e\n    \u003cimg src='https://img.shields.io/david/LotusTM/Kotsu.svg' alt='Dependency Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://david-dm.org/LotusTM/Kotsu?type=dev'\u003e\n    \u003cimg src='https://img.shields.io/david/dev/LotusTM/Kotsu.svg' alt='DevDependency Status' /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## How to use\n\n1. Clone or download and unpack to desired location\n2. Download and install latest version of [node.js](http://nodejs.org/)\n3. Install [GraphicsMagick](http://www.graphicsmagick.org/download.html) (recommended) or [ImageMagick](http://www.imagemagick.org/script/binary-releases.php) for your OS.\n  *Note: it's mandatory to install one of them before running `npm install`*\n4. Set your environment variables [[guide](https://github.com/LotusTM/Kotsu/wiki/Set-up-environment-variables)]\n5. Install project dependencies: `npm install`\n6. *(optional)* Add your repository to [Travis](https://travis-ci.org/) for automatic tests\n7. *(optional)* Set up Continuous Deployment with [CircleCI](https://circleci.com/) or [Werker](http://wercker.com/) Docker following our [guide](https://github.com/LotusTM/Kotsu/wiki/Continuous-Delivery-with-Wercker-Docker-and-CoreOS)\n8. Code live with: `npm start` or `npm start -- --hmr` if you need [Hot Module Reloading](https://github.com/alexisvincent/systemjs-hot-reloader/)\n9. Build with: `npm run build`\n10. Deploy and enjoy your life\n\n## What's inside?\n\n* Reasonable structure for frontend projects\n* Static pages generation\n* Prepared configs for quick Continuous Deployment and automatic tests setup\n* [Grunt](http://gruntjs.com/) with pre-configured tasks\n* [Nunjucks](http://mozilla.github.io/nunjucks/), a full featured templating engine\n* In-built Nunjucks globals and filters for formatting numbers, dates, getting current page url, locale, breadcrumb, etc.\n* Human readable urls\n* Boilerplate files based on best practices\n* i18n with [node-gettext](https://github.com/andris9/node-gettext) and configured layouts to properly declare current locale and alternate urls\n* [Sass](http://sass-lang.com/) compiler with source maps generation, [autoprefixing](https://github.com/postcss/autoprefixer), [optimization](https://github.com/giakki/uncss), [minification](https://github.com/css/csso) and [linting](https://github.com/stylelint/stylelint)\n* [Ekzo](https://github.com/ArmorDarks/ekzo) Sass framework\n* [Webpack](https://webpack.js.org/) with ES6 support, managing and bundling JavaScript dependencies and optional [hot module reloading](https://github.com/alexisvincent/systemjs-hot-reloader/) or blazing fast watch\n* [standard](https://github.com/feross/standard) for linting and automatic formatting JavaScript\n* Live reload powered by [webpack-dev-server](https://github.com/webpack/webpack-dev-server)\n* Runtime type annotation and data validation with [`tcomb`](https://github.com/gcanti/tcomb) and [`tcomb-validation`](https://github.com/gcanti/tcomb-validation), built-in handy refinements.\n* Preconfigured meta tags for [Open Graph](http://ogp.me/) and [Twitter Cards](https://dev.twitter.com/cards/overview)\n* Commonly used by search providers structured data based on [RDFa](https://rdfa.info/)\n* Automatic `sitemap.xml` generation with [grunt-sitemap-xml](https://github.com/lotustm/grunt-sitemap-xml)\n* Automatic sprites generation with [Spritesmith](https://github.com/Ensighten/grunt-spritesmith)\n* Automatic images compression via [TinyPNG](https://tinypng.com/)\n* Automatic responsive images generation with [grunt-responsive-images](https://github.com/andismith/grunt-responsive-images)\n* Separate not optimized files in development, and\n* Compiled and minified files for production\n\nAnd a lot more under the hood. We just didn't have time to document all features. Yet.\n\n## Documentation\n\n_Work in progress_\n\n* [Structure](https://github.com/LotusTM/Kotsu/blob/master/docs/Structure.md)\n* [Environment variables](https://github.com/LotusTM/Kotsu/blob/master/docs/Environment-variables.md)\n* [Data](https://github.com/LotusTM/Kotsu/blob/master/docs/Data.md)\n* [Structured data](https://github.com/LotusTM/Kotsu/blob/master/docs/Structured-data.md)\n* [URLs](https://github.com/LotusTM/Kotsu/blob/master/docs/URLs.md)\n* [Continuous Delivery](https://github.com/LotusTM/Kotsu/blob/master/docs/Continuous-Delivery.md)\n* [Recipes](https://github.com/LotusTM/Kotsu/blob/master/docs/Recipes.md)\n\n## Examples\n\nDeployed version of Kotsu from master branch can be found [here](https://kotsu.2bad.me).\n\nNote that Examples section so far features only least part of predefined elements and features.\n\n## Browsers support\n\n### JavaScript\n\n| IE | Edge | Chrome | Firefox | Safari | Opera | Opera Mobile | iOS Safari | Android |\n|----|------|--------|---------|--------|-------|--------------|------------|---------|\n| 9+ | 12+  | 21+    | 28+     | 6.1+   | 12.1+ | 12.1+        | 7+         | 4+      |\n\nTo enable ES6 features in IE11 and below, uncomment `import 'babel-polyfill'` in [`main.js`](https://github.com/LotusTM/Kotsu/blob/master/source/scripts/main.js). See details [here](https://babeljs.io/docs/usage/polyfill/).\n\nDefault build shipped with jQuery 3.1.0+ which doesn't support IE8. Replace it with pre 3.0.0 version if you need support of IE8.\n\n### CSS\n\n|  IE | Edge | Chrome | Firefox | Safari | Opera | Opera Mobile | iOS Safari | Android |\n|-----|------|--------|---------|--------|-------|--------------|------------|---------|\n| 10+ | 12+  | 21+    | 28+     | 6.1+   | 12.1+ | 12.1+        | 7.1+       | 4.4+    |\n\nRefer to [Ekzo Browsers Support](https://github.com/ArmorDarks/ekzo#browsers-support) section for details about graceful regression for IE9 and below, which included in Kotsu by default.\n\nTo disable graceful regressions for older IE, remove `IE()` macro call from base layout.\n\n### Outdated Browser message\n\nIn IE9 and below users will see banner before page content with message about outdated browser and link to [Outdated Browser](http://outdatedbrowser.com).\n\nTo disable Outdated Browser message, remove `OutdatedBrowser()` macro call from base layout.\n\n## License\n\nCopyright 2014 LotusTM. Licensed under the [Apache 2.0 license](https://github.com/LotusTM/Kotsu/blob/master/LICENSE.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flotustm%2Fkotsu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flotustm%2Fkotsu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flotustm%2Fkotsu/lists"}