{"id":19856980,"url":"https://github.com/johnvuko/base-static-site","last_synced_at":"2025-10-08T09:58:38.222Z","repository":{"id":31950413,"uuid":"35520236","full_name":"johnvuko/base-static-site","owner":"johnvuko","description":"Base scaffold for simple static website using compression and minification","archived":false,"fork":false,"pushed_at":"2015-10-25T19:20:52.000Z","size":143,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-08T09:58:34.309Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","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/johnvuko.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}},"created_at":"2015-05-13T00:53:17.000Z","updated_at":"2020-04-03T13:30:05.000Z","dependencies_parsed_at":"2022-08-24T10:30:54.245Z","dependency_job_id":null,"html_url":"https://github.com/johnvuko/base-static-site","commit_stats":null,"previous_names":["johnvuko/base-static-site"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/johnvuko/base-static-site","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnvuko%2Fbase-static-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnvuko%2Fbase-static-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnvuko%2Fbase-static-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnvuko%2Fbase-static-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnvuko","download_url":"https://codeload.github.com/johnvuko/base-static-site/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnvuko%2Fbase-static-site/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278924143,"owners_count":26069400,"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-10-08T02:00:06.501Z","response_time":56,"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-11-12T14:17:07.434Z","updated_at":"2025-10-08T09:58:38.201Z","avatar_url":"https://github.com/johnvuko.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Base scaffold for static web development\n\nThis code is a scaffold for landing page. It minify your code, optimize your images and create a gzip version of every files.\n\nThe goal is to optimize the size and the speed of the website at the maximum.\n\n## Requirements\n\nYou need to have the followings package installed:\n- [npm](https://www.npmjs.com/) Package manager for [NodeJS](https://nodejs.org)\n- [clean-css](https://github.com/jakubpawlowicz/clean-css) Minify your CSS\n- [UglifyJS 2](https://github.com/mishoo/UglifyJS2) Minify your Javascript\n- [html-minifier](https://github.com/kangax/html-minifier) Minify your HTML\n- [optipng](http://optipng.sourceforge.net) Compress your PNG images (version 0.7 minimum)\n- [jpegoptim](http://www.kokkonen.net/tjko/projects.html) Compress your JPEG images\n\n## Installing Dependencies\n\n- `npm` is installed with `NodeJS`, [check NodeJS documentation for more details](https://nodejs.org/download/)\n\n- `clean-css`, `UglifyJS 2` and `html-minifier` are npm packages:\n```shell\n    sudo npm install clean-css -g\n    sudo npm install uglify-js -g\n    sudo npm install html-minifier -g\n```\n\n- `optipng` can be installed with:\n```shell\n    sudo apt-get install optipng\n```\nCheck the version of `optipng` with `optipng -v` if it's inferior to 0.7, you have to download optipng at http://optipng.sourceforge.net/\n\n- `jpegoptim` can be installed with:\n```shell\n    sudo apt-get install jpegoptim\n```\n\n## Usage\n\nOnce you have everything is installed, you have to copy the repository:\n```shell\ncurl -L -O https://github.com/jonathantribouharet/base-static-site/archive/master.zip \u0026\u0026 unzip master \u0026\u0026 rm master.zip \u0026\u0026 mv base-static-site-master site\n```\nThis command download the latest version, unzip it in `site` folder and remove the downloaded archive.\n\nCompress and minify your code with:\n```shell\n./compress.sh\n```\nThe command generate a `prod` folder containg your project fully optimized.\n\n### What's in it?\n\n- `dev` folder, it's your working folder, every pages must be in it with `.html` extension. By default you have an `index.html` file with the minimum.\n- `dev/css`, every css files must be in it with `.css` extension. By default you have a `reset.css` and an empty file `style.css`.\n- `dev/img`, every images must be in it with `.png` or `.jpg` extension.\n- `dev/js`, every javascript files must be in it with `.js`.\n- `dev/font`, used for fonts but no particular process are applied to this folder.\n- `compress.sh`, the script you have to run for create the `prod` folder with every files minified and compressed.\n\n### How it works\n\nWhen you run `compress.sh` by doing\n```shell\n./compress.sh\n```\n\n- it create a new folder `prod` (remove the older one if exist)\n- copy the HTML, Javascript, CSS and fonts files from `dev` to `prod`\n- minify your HTML, Javascript and CSS files\n- optimize your images files\n- create a `gzip` version of every files. It avoid the server to do it dynamically and we use a the biggest compression existing. If you use [nginx](http://nginx.org/), check the [gzip_static](http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html) option, activate with `gzip_static on;`\n\n## Author\n\n- [Jonathan Tribouharet](https://github.com/jonathantribouharet) ([@johntribouharet](https://twitter.com/johntribouharet))\n\n## License\n\nThis code is released under the MIT license. See the LICENSE file for more info.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnvuko%2Fbase-static-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnvuko%2Fbase-static-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnvuko%2Fbase-static-site/lists"}