{"id":16594404,"url":"https://github.com/simonpadbury/gulp-quickstart","last_synced_at":"2026-04-09T12:39:27.026Z","repository":{"id":73601042,"uuid":"311894245","full_name":"SimonPadbury/gulp-quickstart","owner":"SimonPadbury","description":"Gulp tasks for Babel (ES6), SCSS, Nunjucks, and other helps for sourcemaps and minification. With browser-sync.","archived":false,"fork":false,"pushed_at":"2020-12-04T14:52:05.000Z","size":105,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-06T17:24:37.343Z","etag":null,"topics":["babel","browsersync","gulp","nunjucks","scss"],"latest_commit_sha":null,"homepage":"","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/SimonPadbury.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":"2020-11-11T07:24:30.000Z","updated_at":"2022-03-28T21:18:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5f0a810-c6a2-4efc-be16-ab95a5f2b21f","html_url":"https://github.com/SimonPadbury/gulp-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SimonPadbury/gulp-quickstart","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fgulp-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fgulp-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fgulp-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fgulp-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimonPadbury","download_url":"https://codeload.github.com/SimonPadbury/gulp-quickstart/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fgulp-quickstart/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263379522,"owners_count":23457862,"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":["babel","browsersync","gulp","nunjucks","scss"],"created_at":"2024-10-11T23:46:11.082Z","updated_at":"2025-12-30T22:18:10.382Z","avatar_url":"https://github.com/SimonPadbury.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gulp Quickstart\n\nThis little starter project has enables you to get a Gulp project up and running, with Babel, Sass, Nunjucks and other helps for sourcemaps and minification.\n\n## Setup\n\n1. First, you need [NodeJS](https://nodejs.org/) installed.\n\n2. Then with this project downloaded to your computer, you need to install each of the following packages as dev dependencies:\n\n    * @babel/core\n    * @babel/preset-env\n    * babel\n    * browser-sync\n    * cssnano\n    * postcss\n    * gulp\n    * gulp-babel\n    * gulp-concat\n    * gulp-nunjucks-render\n    * gulp-postcss\n    * gulp-sass\n    * gulp-sourcemaps\n    * gulp-uglify\n    \n    Just `cd` into your new project folder and do this:\n\n    ```bash\n    npm install\n    ```\n\n    And wait.\n\n3. After all the dev dependencies have been installed, you just need to use `gulp` and it will do all the tasks. In the terminal:\n\n    ```bash\n    gulp\n    ```\n\n    BrowserSync will be started automatically, and it will look for `index.html` in your so that it can serve it from `./public` to your [http://localhost:3000](http://localhost:3000).\n\n\n## Starting your work\n\nSo, you need to start with the `index.njk` that’s directly inside `./src/pages`. There’s a _Hello world_ example with some proof tests waiting for you there.\n\nWhen you start `gulp` the first time, it will run through everything and create a `./public/` folder.\n\nYour `./src/pages/index.njk` will be rendered as `./public/index.html` and served to your browser.\n\nOnce you’ve seen that it’s all working OK, you can go ahead and remove the test dummy content and do your own thing.\n\n## The Gulp tasks\n\nThe Gulp tasks are looking for folders in your `./src` directory.\n\n* `./src/js` — ES6 content will be processed by Babel to ES5 and bundled to `./public/js/bundle.js`\n\n* `./src/scss` — SCSS content will be preprcessed to CSS and become `./public/css/style.css`\n\n* `./src/pages` — Nunjucks files in here will be rendered as HTML files in `./public`. You need at least `./src/pages/index.njk` (or `./src/pages/index.html`) for creating `./public/index.html`. Remember to set up your own links to `style.css` and `bundle.js`.\n\n* The Nunjucks task will also look in `./src/partials` – so you can organize your partials in there, and include them in your page templates.\n\n* Use `./src/assets` for any “past through copy” such as images and third-party CSS and/or JS libraries. The following file types, together with their directory structure that you may set up inside `./src/assets`, will simply be coped to  `./public` (you can add more to the `fileCopyTask()` in `gulpfile.js`):\n\n    * `.html`\n    * `.css`\n    * `.js`\n    * `.map`\n    * `.svg`\n    * `.gif`\n    * `.jpg`\n    * `.png`\n\n    **Note:** If you create directories such as `./src/assets/css` and `./src/assets/js`, these will be merged with `./public/css` and `./public/js`, no problem.\n\n## Can this project be used as a static site generator?\n\nYes.\n\n_Gulp Quickstart_ is, in fact, a simple static site generator, and it can be used for simple websites.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonpadbury%2Fgulp-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonpadbury%2Fgulp-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonpadbury%2Fgulp-quickstart/lists"}