{"id":23156549,"url":"https://github.com/thecreation/web-boilerplate","last_synced_at":"2025-08-11T09:08:57.525Z","repository":{"id":148923039,"uuid":"135561910","full_name":"thecreation/web-boilerplate","owner":"thecreation","description":null,"archived":false,"fork":false,"pushed_at":"2019-07-23T08:33:12.000Z","size":240,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-06T09:02:14.570Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thecreation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-31T09:24:05.000Z","updated_at":"2019-07-23T08:33:14.000Z","dependencies_parsed_at":"2023-04-29T10:06:13.723Z","dependency_job_id":null,"html_url":"https://github.com/thecreation/web-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thecreation/web-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fweb-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fweb-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fweb-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fweb-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecreation","download_url":"https://codeload.github.com/thecreation/web-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fweb-boilerplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269857485,"owners_count":24486395,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-12-17T21:13:57.535Z","updated_at":"2025-08-11T09:08:57.512Z","avatar_url":"https://github.com/thecreation.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Web Boilerplate\n\n\u003e A starter template for Handlebar, ECMAScript(latest), sass and postcss.\n\n## Table of Contents\n\n* [Features](#features)\n* [Installation](#installation)\n* [Getting Started](#getting-started)\n* [List of Npm tasks](#list-of-npm-tasks)\n* [Configuration](#configuration)\n* [Directory Structure](#directory-structure)\n\n## Features\nThis starter also features a number of great software (in the words of their creators):\n\n* [Lanyon](http://lanyon.getpoole.com/) - a content-first, sliding sidebar theme (originally) for Jekyll (by [mdo](http://mdo.fm)).\n* [Browsersync](https://www.browsersync.io/) - time-saving synchronised browser testing, keep multiple browsers \u0026 devices in sync when editing files.\n* [EditorConfig](http://editorconfig.org/) - a config file for maintaining  consistent coding styles.\n\n### Assets\n\n* [svgo](https://github.com/svg/svgo) - a Node.js module for optimizing SVG vector graphics files.\n* [Favicons](https://github.com/evilebottnawi/favicons) - a Node.js module for generating favicons and their associated files.\n* [imagemin](https://github.com/imagemin/imagemin) - a Node.js module for minify images seamlessly.\n* [assets-manager](https://github.com/thecreation/assets-manager) - a Node.js module for transfer the required files from your registry distributions to the target.\n\n### JavaScript\n\n* [Babel](http://babeljs.io/) - a JavaScript compiler for es5 to es6/7.\n* [rollup](https://rollupjs.org/) - a module bundler for JavaScript.\n* [ESLint](http://eslint.org/) - the pluggable linting utility for JavaScript and JSX (with preconfigured ruleset by [Google](https://github.com/google/eslint-config-google).\n* [UglifyES](https://github.com/mishoo/UglifyJS2) - A JavaScript parser, mangler/compressor and beautifier toolkit for ES6+.\n\n### StyleSheet\n\n* [Sass](http://sass-lang.com/) - CSS with superpowers.\n* [PostCSS](https://github.com/postcss/postcss) - a tool for transforming styles with JS plugins.\n* [Autoprefixer](https://github.com/postcss/autoprefixer) - adding vendor prefixes by the rules of [Can I Use](http://caniuse.com/).\n* [cssnano](http://cssnano.co/) - A modular minifier based on the PostCSS ecosystem..\n* [Stylelint](http://stylelint.io/) - a mighty, modern CSS linter (with preconfigured ruleset by [Hugo Giraudel](https://sass-guidelin.es/)).\n\n### Html\n\n* [handlebars](https://github.com/wycats/handlebars.js) - a javascript template engine.\n* [handlebars-wax](https://github.com/shannonmoeller/handlebars-wax) - Effortless registration of data, partials, helpers, and decorators using file-system globs, modules, and plain-old JavaScript objects.\n* [handlebars-layouts](https://github.com/shannonmoeller/handlebars-layouts) - a handlebars helpers which implement layout blocks.\n* [handlebars-helpers](https://github.com/helpers/handlebars-helpers) - More than 180 Handlebars helpers in ~20 categories.\n* [HTMLHint](https://github.com/yaniswang/HTMLHint) - a Static Code Analysis Tool for HTML.\n\n### Rollup plugins\n\n* [rollup-plugin-node-resolve](https://github.com/rollup/rollup-plugin-node-resolve) - Use the Node.js resolution algorithm with Rollup.\n* [rollup-plugin-commonjs](https://github.com/rollup/rollup-plugin-commonjs) - Convert CommonJS modules to ES2015.\n\n### Git Hooks manager\n\n* [husky](https://github.com/typicode/husky)\n* [lint-staged](https://github.com/okonet/lint-staged)\n\n## Installation\n\n### Node version manager\n\nInstall [NVM](https://github.com/creationix/nvm). And use the latest version of NodeJS.\n\n```bash\nnvm install node\nnvm use node\n```\n\n### Install Sass\n\nGo to [sass-lang.com/install](http://sass-lang.com/install) for installation in command line.\n\n```bash\ngem install sass\n```\n\nBefore install sass, you should [install Ruby](https://www.ruby-lang.org/en/documentation/installation/) and [install Gem](https://rubygems.org/pages/download).\n\n## Getting started\n\n1. Clone this Boilerplate\n\n   ```bash\n   git clone https://github.com/thecreation/web-boilerplate.git \u003cPROJECT_NAME\u003e\n   cd \u003cPROJECT_NAME\u003e\n   ```\n\n2. Install Dependencies\n\n   ```bash\n   npm install\n   ```\n\n3. Build the project\n\n   ```bash\n   npm run build\n   ```\n\n4. Stay up-to-date\n\n   ```bash\n   git remote add upstream https://github.com/thecreation/web-boilerplate.git\n   git pull upstream master\n   ```\n\n## List of Npm tasks\n\nTo run separate task type in command line `npm run [task_name]`.\n\n### Main tasks\nTask name          | Description\n:------------------|:----------------------------------\n`start`            | will start all tasks required by project in dev mode: initial build, watch files, run server with livereload\n`build`            | builds all content and assets from `src` to `dist`.\n`dev`              | builds your project without optimization.\n\n### Core tasks\nTask name          | Description\n:------------------|:----------------------------------\n`css`              | compile all scss from `src/styles` to `dist/assets/css` folder.\n`js`               | compile all js from `src/scripts` to `dist/assets/js` folder.\n`html`             | compile all hbs files to html files.\n\n### Assets related tasks\nTask name          | Description\n:------------------|:----------------------------------\n`copy`             | copy files from `src/assets` path to `dist/assets` path.\n`vendor`           | copy vendor files from registry distributions to `dist/assets/vendor` path.\n`svg`              | optimize svg files.\n`favicon`          | generate favicons to `dist/assets/favicon` path.\n`img`              | optimize and copies images in `src/images` to `dist/assets/images`.\n\n### Dev tasks\nTask name          | Description\n:------------------|:----------------------------------\n`clean`            | remove `dist` folder.\n`serve`            | start a BrowserSync instance.\n`watch`            | watchs for changes in `src/` path and rebuilds parts of the site as necessary.\n\nAll available tasks are placed in a folder `scripts`.\n\n### Flags\n`npm run [task_name] --prod` or `npm run [task_name] --production` to run task in production mode.\n\n### Workflow\nEverything's ready to get started right away:\n\n`npm start` - Compiles assets \u0026 html, launches development server:\n\n* compiles styles \u0026 scripts are being compiled \u0026 concatenated\n* compresses images \u0026 svgs\n* builds the site \u0026 opens it in your default browser\n* watches for changes and injects them right away\n\n`npm run build` - Same as above, but in production mode:\n\n* compiles \u0026 builds everything\n* minifies \u0026 compresses everything\n\n## Configuration\nGlobal variables and site metadata can be found inside `config.js`. Your can make some modification in the file.\n\n## Directory Structure\n\nThe `source` directory contains your entire application code, including CSS, JavaScript, HTML.\n\nThe rest of the folders and files only exist to make your life easier, and should not need to be touched.\n\nBelow you can find full details about significant files and folders.\n\n```bash\n├── README.md               # Readme file\n├── package.json            # Dependencies for node.js\n├── LICENSE                 # License\n├── .gitignore              # Git ignore rules\n├── .htmlhintrc             # Settings for HTMLHint\n├── /scripts/               # Npm scripts definitions\n├── /dist/                  # Minified, optimized and compiled files\n│   ├── /assets/            # Assets folder\n│   │   ├── /css/           # CSS files\n│   │   ├── /js/            # JS files\n│   │   ├── /img/           # Images folder\n│   │   ├── /svg/           # Svg files\n│   │   └── /favicon/       # Favicon files\n│   └── *.html              # Rendered and compiled HTMLs from hbs\n└── /src/                   # The source code of the application\n    ├── /assets/            # Static assets files copy to dist\n    ├── /data/              # Metadata associated with the site.\n    ├── /favicon/           # Favicon image\n    ├── /styles/            # Stylesheets source\n    ├── /scripts/           # Javascript source\n    ├── /images/            # Non compressed image files\n    ├── /svgs/              # Non compressed svg files\n    ├── /helpers/           # Handlebars helpers\n    ├── /layouts/           # Handlebars layouts that are based on\n    ├── /partials/          # Handlebars partials that are included / extended\n    └── /pages/             # Handlebars pages, one per page on the site\n```\n\n## License\n\nThe code is available under the [MIT](https://github.com/thecreation/web-boilerplate/blob/master/LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fweb-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecreation%2Fweb-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fweb-boilerplate/lists"}