Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MaedahBatool/pudl
🐶 A JavaScript-based Static Site Generator — for quick static site prototyping. Jamstack with Gulp.
https://github.com/MaedahBatool/pudl
hacktoberfest hacktoberfest-accepted hacktoberfest2022
Last synced: about 2 months ago
JSON representation
🐶 A JavaScript-based Static Site Generator — for quick static site prototyping. Jamstack with Gulp.
- Host: GitHub
- URL: https://github.com/MaedahBatool/pudl
- Owner: MaedahBatool
- Created: 2018-07-05T10:51:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T02:05:36.000Z (over 1 year ago)
- Last Synced: 2024-07-19T16:37:33.921Z (2 months ago)
- Topics: hacktoberfest, hacktoberfest-accepted, hacktoberfest2022
- Language: Handlebars
- Homepage:
- Size: 831 KB
- Stars: 79
- Watchers: 2
- Forks: 94
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/gulp-poodle) [](https://www.npmjs.com/package/gulp-poodle) [](https://www.npmjs.com/package/gulp-poodle) [](https://www.npmjs.com/package/gulp-poodle)
🎯 pudl is a JavaScript-based static site generator (SSG) for quick-prototyping and creating awesome little static demos while teaching/presenting. It significantly cuts down your dev-setup time and improves productivity. It also gives a nice developer experience.
A FOSS (Free & Open Source Software) automation workflow project. Developed and Maintained by @MaedahBatool.
## 🐶 What can `pudl` do?
1. Live reloads browser with BrowserSync.
2. CSS: Sass to CSS conversion, error catching, Autoprefixing and CSS minification.
3. Watches files for changes in CSS.
4. Corrects the line endings.
5. InjectCSS instead of browser page reload.
6. Sends message notification to you.
7. Prevents pipe breaking caused by errors.
## 🔥 Getting started
STEP #0 — Don't have Node.js + npm installed? Read this small guide. (CLICK TO EXPAND!)
In case you are an absolute beginner to `Node.js`, JavaScript, and `npm` packages — all you need to do is go to the Node's site [download + install](https://nodejs.org/en/download/) Node on your system. This will install both `Node.js` and `npm`, i.e., node package manager — the command line interface of Node.js.
You can verify a successful installation by opening your terminal app and then start typing...
```sh
node -v
# Results into v9.11.2 — please make sure you have Node >= 8 installed.
npm -v
# Results into v6.2.0 — please make sure you have npm >= 5.3 installed.
```
### ➡️ Step #1. Download the required files
Download the [`gulpfile.js`](https://raw.githubusercontent.com/MaedahBatool/pudl/master/dist/gulpfile.js), [`package.json`](https://raw.githubusercontent.com/MaedahBatool/pudl/master/dist/package.json), [`.gitignore`](https://raw.githubusercontent.com/MaedahBatool/pudl/master/dist/.gitignore), and [`config.js`](https://raw.githubusercontent.com/MaedahBatool/pudl/master/dist/config.js) files inside the root folder of your project.
_**OR** use your terminal to browse your desired folder and run the following command that downloads all the required files for you via cURL._
```sh
curl -L https://git.io/pudlgfl -o "gulpfile.js" && curl -L https://git.io/pudlpkjs -o "package.json" && curl -L https://git.io/pudlgig -o ".gitignore" && curl -L https://git.io/pudlcg -o "config.js"
```
### ➡️ STEP #2: Editing the project variables
Next, change the project variables in the `config.js` file according to your folder structure.
```js
// List of Project Variables.
module.exports = {
viewSrc: './views/**/*.pug',
viewDst: './',
styleSrc: './css/style.scss',
styleDst: './',
outputStyle: 'compressed',
viewWatchFiles: './views/**/*.pug',
styleWatchFiles: './css/**/*.scss',
browserAutoOpen: false,
injectChanges: true
};
```
### ➡️ STEP #3: Installing the node dependencies
In the root folder of your development project install the Node Dependencies. In the terminal run the following command and wait for it to download all the `node.js` dependencies. It's a one-time process and can take about 5 minutes or more depending on the speed of your internet connection.
```sh
# For MAC OS X run the following command with super user.
npm install
# For Linux run the following command.
npm install
```
### ➡️ STEP #4: Run `npm start`
Finally, run the following command to get up and running with pudl.
```sh
# To start pudl
npm start
# To stop pudl press CTRL (⌃) + C
```
Now `gulp` will start watching your `pug` and `sass` files for any changes and provides you with a link through which you can access your site locally. The localhost link can be accessed by `http://localhost:3000/`.
## Licensing
Released under GNU GPLv2.0 or later license.
Copyright [Maedah Batool](https://twitter.com/MaedahBatool)
---
### 🙃 **Hello, we're the [Dev Couple](https://TheDevCouple.com)**!
[Ahmad Awais](https://twitter.com/mrahmadawais/) (my husband) is an OSS developer advocate, Full Stack Web Developer and a regular core contributor at WordPress. I ([Maedah Batool](https://twitter.com/MaedahBatool/)) is a Technical Content Program Manager, and I'm also a WordPress Core Contributor. Together with our [team](https://TheDevCouple.com/team), we run the [TheDevCouple.com](https://TheDevCouple.com/).
If you'd like to get insights into our love for open source software, professional full stack development, WordPress community, the growth of JavaScript or growing a family, building, and bootstrapping a business, then subscribe to our newsletter called ↣ [The Developers Takeaway](http://thedevtakeaway.ahmadawais.com/)!
#### [**Support our Open Source Projects!**](https://pay.paddle.com/checkout/515568) 🎩
If you'd like us to keep producing professional free and open source software (FOSS). Consider [paying for an hour of my dev-time](https://pay.paddle.com/checkout/515568). We'll spend two hours on open source for each contribution. Yeah, that's right, you pay for one hour and get both of us to spend an hour as a thank you.
- 🚀 $99.99 — [Support for one hour or more →](https://pay.paddle.com/checkout/515568)
- 🔰 $49.99 — [Support half an hour maintenance →](https://pay.paddle.com/checkout/527253)
- ☕️ $9.99 — [Buy us lunch or coffee to keep us trucking #OpenSource →](https://pay.paddle.com/checkout/527254)
### 🙌 [THEDEVCOUPLE OSS PARTNERS](https://TheDevCouple.com/partners)
This open source project is maintained and supported by the help of awesome companies listed below. [Read more about it here →](https://TheDevCouple.com/partners)
_Follow me 👋 on Twitter for more updates and questions_ → [](https://twitter.com/maedahbatool)