{"id":16327133,"url":"https://github.com/sutter/sutterlity","last_synced_at":"2026-01-16T00:58:47.088Z","repository":{"id":8176884,"uuid":"56564903","full_name":"sutter/Sutterlity","owner":"sutter","description":"Portfolio","archived":false,"fork":false,"pushed_at":"2023-07-11T00:01:39.000Z","size":40706,"stargazers_count":0,"open_issues_count":14,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-08T17:32:04.300Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://sutterlity.fr/","language":"CSS","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/sutter.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-19T04:34:43.000Z","updated_at":"2019-09-19T10:20:03.000Z","dependencies_parsed_at":"2024-10-28T15:36:02.189Z","dependency_job_id":null,"html_url":"https://github.com/sutter/Sutterlity","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/sutter%2FSutterlity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutter%2FSutterlity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutter%2FSutterlity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutter%2FSutterlity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sutter","download_url":"https://codeload.github.com/sutter/Sutterlity/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246932248,"owners_count":20856958,"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":[],"created_at":"2024-10-10T23:10:29.874Z","updated_at":"2026-01-16T00:58:47.050Z","avatar_url":"https://github.com/sutter.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hello Front\n\n[![Maintainability](https://api.codeclimate.com/v1/badges/5f42eea3983e36565d92/maintainability)](https://codeclimate.com/github/sutter/helloFront/maintainability)\n\nBoilerplate SCSS / PUG / ES6 for clean and fast Front-end project.\n\nWork on **src/** folder and gulp build in **dist/**.\n\n## Installation\n\n### Node version manager\n\nInstall [NVM](https://github.com/creationix/nvm)\n\nUse the version v8.9.4 of NodeJS.\n\n```bash\nnvm use\n```\n\n### Install Sass\n\nGo to [sass-lang.com/install](http://sass-lang.com/install) for installation in\ncommand line.\n\n### Install Yarn\n\nGo to\n[https://yarnpkg.com/docs/install](https://yarnpkg.com/docs/install/#mac-tab)\n\n### Install Gulp\n\nGo to [https://gulpjs.com/](https://gulpjs.com/)\n\n### Download the dependencies NPM\n\n```bash\nyarn install\n```\n\n### Install Tooling\n\nUse [Prettier](https://github.com/prettier/prettier) for clean your **JS** /\n**SCSS** files.\n\nPlugin for IDE :\n\n* [Visual Code Studio](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n* [Atom](https://atom.io/packages/prettier-atom)\n* [Sublime text](https://github.com/danreeves/sublime-prettier)\n\n## Commands\n\n### Run project\n\n```bash\nyarn dev\n```\n\n### Build project\n\n```bash\nyarn build\n```\n\n### Optimize SVG\n\n```bash\nyarn svg\n```\n\n### Clean project\n\n```bash\nyarn reset\n```\n\n## How it works\n\n### Works with SCSS\n\nUse [atomic design](http://bradfrost.com/blog/post/atomic-web-design/) design for orgaznise components\n\nThe SCSS files are located in `./src/assets/scss`.\n\nExample SCSS hierarchy :\n\n* **base/** : Unclassed HTML elements (type selector)\n* **atoms/** : Atoms are the basic building blocks of matter (button, input, etc.)\n* **molecules/** : Molecules are groups of atoms bonded together and are the smallest fundamental units of a compound (from, cards, etc.)\n* **organisms/** : Molecules give us some building blocks to work with, and we can now combine them together to form organisms. (header, footer, etc.)\n* **template/** : Templates consist mostly of groups of organisms stitched together to form pages.\n* **page/** : Pages are specific instances of templates\n* **tools/** : Default mixin and functions\n* **utils/** : Helpers and overrides\n* **\\_settings.scss** : Global variables\n* **app.scss** : Main stylesheet\n\nUse the [SUIT CSS](https://github.com/suitcss/suit/blob/master/doc/naming-conventions.md) namming convention.\n\n### Works with Pug templating\n\nThe PUG files are located in `./src/template`\n\n* **layout** : layout of html files generated\n* **mixin** : for reusable pattern\n* **pages** : the content of html files generated\n* **partial** : includes of html pattern\n* **config.pug** : global variables\n\n### Works with JavaScript\n\nThe Javascript files are located in `./src/assets/js`.\n\n**Use the ES6 syntaxe** Babel convert it in ES5 for you via webpack.\n\n### Working with Images\n\nThe Image files are located in `./src/assets/img`\n\nAccepted file formats : - jpg - png - gif - svg\n\n### Working with Fonts\n\nThe font files are located in `./src/assets/font`\n\n### Works with icons font\n\nDisabled by default, for activate do :\n\n* in `./gulp/config.js` at [line 68](https://github.com/sutter/helloFront/blob/master/gulp/config.js#L68) update value : `enable: true`;\n* Add\n  [\\_template-font-custom.scss](https://gist.github.com/sutter/5f9471f95f6d5f388704721272b4a21e)\n  in `./src/assets/scss/tools/`;\n* Add SVG Files in folder `./src/assets/icons` and gulp made magic.\n\n[Preparing-svgs](https://www.npmjs.com/package/gulp-iconfont#preparing-svgs)\n\n* Icon format: svg\n* Icon size: 512x512\n* Vectorize stroke\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsutter%2Fsutterlity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsutter%2Fsutterlity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsutter%2Fsutterlity/lists"}