{"id":26003127,"url":"https://github.com/asuh/sage-starter","last_synced_at":"2025-03-05T20:01:44.768Z","repository":{"id":4611805,"uuid":"43985843","full_name":"asuh/sage-starter","owner":"asuh","description":"The best  starter theme with a modern front-end development workflow. Based on Sage, HTML5 Boilerplate, gulp, Bower, and Bootstrap.","archived":false,"fork":false,"pushed_at":"2025-02-12T03:48:21.000Z","size":7344,"stargazers_count":43,"open_issues_count":10,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-12T04:36:26.314Z","etag":null,"topics":["bower","browsersync","gulp","html5-boilerplate","sass","starter-theme","svg","svg-sprites"],"latest_commit_sha":null,"homepage":"https://github.com/asuh/sage-starter","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asuh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-10-10T00:12:49.000Z","updated_at":"2025-02-12T03:48:25.000Z","dependencies_parsed_at":"2023-07-06T05:54:00.140Z","dependency_job_id":null,"html_url":"https://github.com/asuh/sage-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asuh%2Fsage-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asuh%2Fsage-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asuh%2Fsage-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asuh%2Fsage-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asuh","download_url":"https://codeload.github.com/asuh/sage-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242097418,"owners_count":20071252,"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":["bower","browsersync","gulp","html5-boilerplate","sass","starter-theme","svg","svg-sprites"],"created_at":"2025-03-05T20:00:23.028Z","updated_at":"2025-03-05T20:01:44.738Z","avatar_url":"https://github.com/asuh.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!NOTE]\n\u003e I will deprecate this project in favor of a new starter theme based on Sage 9 called [Forage](https://github.com/asuh/forage). I highly recommend to switch to Forage which is in active development and has fewer dependencies.\n\n# [Sage Starter](https://github.com/asuh/sage/)\n\nSage Starter is a starter theme based on Roots Sage theme version 8.6, which references HTML5 Boilerplate, Gulp, and Bower that will help you make better websites.\n\n* Homepage: [https://github.com/asuh/sage-starter/](https://github.com/asuh/sage-starter/)\n* Source: [https://github.com/roots/sage](https://github.com/roots/sage)\n* Documentation: [https://roots.io/sage/docs/](https://roots.io/sage/docs/)\n\n## Requirements\n\n| Prerequisite      | How to check | How to install\n| ----------------- | ------------ | ------------- |\n| Node.js \u003e= 6.9.x | `node -v`    | [nodejs.org](https://nodejs.org/) |\n| gulp-cli \u003e= 2.0.0 | `gulp -v`    | `npm install -g gulp-cli` |\n| Bower \u003e= 1.3.12   | `bower -v`   | `npm install -g bower` |\n| Optional | | |\n| PHP \u003e= 7.x.x      | `php -v`     | [php.net](https://www.php.net/manual/en/install.php) |\n\nPHP is optional, but use the latest PHP version that's available.\n\nFor more installation notes, refer to the [Install gulp and Bower](#install-gulp-and-bower) section in this document.\n\n## Features\n\n* [gulp](https://gulpjs.com/) build script that compiles both Sass and Less, checks for JavaScript errors, optimizes images, and concatenates and minifies files\n* [BrowserSync](https://www.browsersync.io/) for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing\n* [Bower](https://bower.io/) for front-end package management\n* [asset-builder](https://github.com/austinpray/asset-builder) for the JSON file based asset pipeline\n* ARIA roles and microformats\n\n## Installation\n\nClone the git repo - `git clone https://github.com/asuh/sage-starter.git` and then rename the directory to the name of your theme or website.\n\n## Theme development\n\nSage Starter uses [gulp](https://gulpjs.com/) as its build system and [Bower](https://bower.io/) to manage front-end packages.\n\nBower is outdated and not recommended since the mid-2010s, but will remain in this starter project for the time being.\n\n### Install gulp and Bower\n\nBuilding this project requires [node.js](https://nodejs.org/download/). For best results, update to the latest version of npm: `npm i -g npm@latest`. I personally recommend using [NVM](https://github.com/nvm-sh/nvm).\n\nFrom the command line:\n\n1. Install [gulp-cli](https://gulpjs.com) and [Bower](https://bower.io/) globally with `npm i -g gulp bower`\n2. Navigate to the theme directory, then run `npm i`\n3. Run `bower install`\n\nYou now have all the necessary dependencies to run the build process.\n\n### Available gulp commands\n\n* `gulp` — Compile and optimize the files in your assets directory\n* `gulp watch` — Compile assets when file changes are made\n* `gulp --production` — Compile assets for production (no source maps).\n\n### Using BrowserSync\n\nTo use BrowserSync during `gulp watch` you need to update `devUrl` at the bottom of `assets/manifest.json` to reflect your local development hostname.\n\nFor example, if your local development URL is `http://project-name.test` you would update the file to read:\n```json\n...\n  \"config\": {\n    \"devUrl\": \"http://project-name.test\"\n  }\n...\n```\nIf your local development URL looks like `http://localhost:8888/project-name/` you would update the file to read:\n```json\n...\n  \"config\": {\n    \"devUrl\": \"http://localhost:8888/project-name/\"\n  }\n...\n```\n\n### SVG support\n\nSage Starter has built-in SVG support! The preferred method for using SVG as implemented is an SVG sprite.\n\n#### Usage\n\nMake sure each SVG has an ID.\n\n```svg\n\u003csvg xmlns=\"http://www.w3.org/2000/svg\"\u003e\n    \u003csymbol id=\"twitter\" viewBox=\"0 0 64 64\"\u003e\n        \u003ctitle\u003eTwitter\u003c/title\u003e\n        \u003cpath etc.../\u003e\n    \u003c/symbol\u003e\n\u003c/svg\u003e\n```\n\nSave any SVG files you want to use into `/assets/images/sprite` and the build process will combine all of those images into `/assets/images/sprite/sprite.svg`.\n\nTo use in markup, apply the ID to an SVG's Use element.\n\n```svg\n\u003csvg role=\"img\" title=\"Twitter\"\u003e\n    \u003cuse xlink:href=\"map.svg#twitter\"/\u003e\n\u003c/svg\u003e\n```\n\nCheck out [SVG For Everybody](https://github.com/jonathantneal/svg4everybody) for IE and \u003c=Edge 12 support of SVG sprites.\n\n## Documentation\n\nSage theme's original documentation is available at [https://docs.roots.io/sage/8.x/installation/](https://docs.roots.io/sage/8.x/installation/). These instructions aren't consistent with Sage Starter but provide historical context for installation and running Gulp.\n\n## Contributing\n\nContributions are welcome and encouraged from everyone!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasuh%2Fsage-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasuh%2Fsage-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasuh%2Fsage-starter/lists"}