<commit_before><p align="center">
  <img
    src="https://raw.githubusercontent.com/electric-eloquence/fepper-npm/master/excludes/fepper-branding.png"
    alt="Fepper"
  >
</p>

<h2 align="center">A frontend prototyper tool for rapid prototyping of websites</h2>

[![Known Vulnerabilities][snyk-image]][snyk-url]
[![Linux Build Status][linux-image]][linux-url]
[![Mac Build Status][mac-image]][mac-url]
[![Windows Build Status][windows-image]][windows-url]
![Node Version][node-version-image]
[![License][license-image]][license-url]

### Downstream projects

* [Fepper Base](https://github.com/electric-eloquence/fepper-base) - no 
  unnecessary assets, styles, demo website, or 
  <a href="https://www.npmjs.com/package/fp-stylus" target="_blank">fp-stylus</a> 
  extension.
* [Fepper for Drupal](https://github.com/electric-eloquence/fepper-drupal) - 
  templates configured for Drupal, along with a Drupal theme built to 
  accommodate those templates.
* [Fepper for Wordpress](https://github.com/electric-eloquence/fepper-wordpress) 
  \- templates configured for WordPress, along with a WordPress theme built to 
  accommodate those templates.

### Table of contents

* [Install](#install)
* [Configure](#configure)
* [Run](#run)
* [Update](#update)
* [Global Data](#global-data)
* [Partial Data](#partial-data)
* [Static Site Generator](#static-site-generator)
* [The Backend](#the-backend)
* [Templater](#templater)
* [Webserved Directories](#webserved-directories)
* [Mustache Browser](#mustache-browser)
* [HTML Scraper](#html-scraper)
* [variables.styl](#variables.styl)
* [UI Customization](#ui-customization)
* [Extensions](#extensions)
* [Express App](#express-app)
* [Mobile Devices](#mobile-devices)
* [I18N](#i18n)
* [Keyboard Shortcuts](#keyboard-shortcuts)
* [More Documentation](#more-documentation)

### <a id="install"></a>Install

#### System requirements

* Unix-like or Windows OS.
* Minimum supported Node.js version 12.0.0.

#### Simplest way to get started

* Download the 
  <a href="https://github.com/electric-eloquence/fepper/releases/latest" target="_blank">
  latest release</a>.

#### Mac install

* In macOS Finder:
  * Double-click `fepper.command`.
  * If not already installed, this will install:
    * Node.js.
    * <a href="https://www.npmjs.com/package/fepper-cli" target="_blank">fepper-cli</a>, 
      which will give you the `fp` command.
  * If opening for the first time, macOS may warn that it can't be opened 
    because it is from an unidentified 
    developer.&nbsp;<a href="https://gist.github.com/e2tha-e/72364ca766cf5d2d1a732b6af4f3b7a8" target="_blank">*</a>
    * In this case, ctrl+click `fepper.command` and click "Open".
    * In the following prompt, click "Open" to confirm that you're sure you 
      want to open it.
  * Enter your password to allow installation.
  * After installation, Fepper should automatically open in a browser.
  * Open http://localhost:3000 if it doesn't open automatically.

#### CLI install

* In Linux and other Unix-like OSs (or if you prefer working on the command 
  line):
  * Install Node.js if it isn't already installed.
  * `npm install -g fepper-cli`
  * `npm install`
  * `fp`

#### Windows install

* In File Explorer, double-click 
  `fepper.vbs`.&nbsp;<a href="https://gist.github.com/e2tha-e/72364ca766cf5d2d1a732b6af4f3b7a8" target="_blank">*</a>
  * If Node.js is not installed, this will install it.
  * After Node.js installation, double-click `fepper.vbs` again.
    * This will install <a href="https://www.npmjs.com/package/fepper-cli" target="_blank">
      fepper-cli</a>, which will give you the `fp` command.
    * It will then install and launch Fepper.

#### Base install

* Comes with no unnecessary assets, styles, demo website, or 
  <a href="https://www.npmjs.com/package/fp-stylus" target="_blank">fp-stylus</a> 
  extension.
* Node.js must be installed beforehand.
* `npm install -g fepper-cli`
* `npm run install-base`
* `fp`

#### Post-install

* To stop Fepper, go to the command line where Fepper is running and press 
  ctrl+c.

### <a id="configure"></a>Configure

Fepper will run out-of-the-box perfectly well with default configurations. 
For further customization, power-users can edit these files:

* conf.yml
* pref.yml
* patternlab-config.json

Edit `conf.yml` to suit the needs of your development environment. If using Git, 
`conf.yml` will not be version controlled by default.<commit_msg>readme update<commit_after><p align="center">
  <img
    src="https://raw.githubusercontent.com/electric-eloquence/fepper-npm/master/excludes/fepper-branding.png"
    alt="Fepper"
  >
</p>

<h2 align="center">A frontend prototyper tool for rapid prototyping of websites</h2>

[![Known Vulnerabilities][snyk-image]][snyk-url]
[![Linux Build Status][linux-image]][linux-url]
[![Mac Build Status][mac-image]][mac-url]
[![Windows Build Status][windows-image]][windows-url]
![Node Version][node-version-image]
[![License][license-image]][license-url]

### Downstream projects

* [Fepper Base](https://github.com/electric-eloquence/fepper-base) - no 
  unnecessary assets, styles, demo website, or 
  <a href="https://www.npmjs.com/package/fp-stylus" target="_blank">fp-stylus</a> 
  extension.
* [Fepper for Drupal](https://github.com/electric-eloquence/fepper-drupal) - 
  templates configured for Drupal, along with a Drupal theme built to 
  accommodate those templates.
* [Fepper for Wordpress](https://github.com/electric-eloquence/fepper-wordpress) 
  \- templates configured for WordPress, along with a WordPress theme built to 
  accommodate those templates.

### Table of contents

* [Install](#install)
* [Configure](#configure)
* [Run](#run)
* [Update](#update)
* [Global Data](#global-data)
* [Partial Data](#partial-data)
* [Static Site Generator](#static-site-generator)
* [The Backend](#the-backend)
* [Templater](#templater)
* [Webserved Directories](#webserved-directories)
* [Mustache Browser](#mustache-browser)
* [HTML Scraper](#html-scraper)
* [variables.styl](#variables.styl)
* [UI Customization](#ui-customization)
* [Extensions](#extensions)
* [Express App](#express-app)
* [Mobile Devices](#mobile-devices)
* [I18N](#i18n)
* [Keyboard Shortcuts](#keyboard-shortcuts)
* [More Documentation](#more-documentation)

### <a id="install"></a>Install

#### System requirements

* Unix-like or Windows OS.
* Minimum supported Node.js version 12.0.0.

#### Simplest way to get started

* Download the 
  <a href="https://github.com/electric-eloquence/fepper/releases/latest" target="_blank">
  latest release</a>.

#### Mac install

* In macOS Finder:
  * Double-click `fepper.command`.
  * If not already installed, this will install:
    * Node.js.
    * <a href="https://www.npmjs.com/package/fepper-cli" target="_blank">fepper-cli</a>, 
      which will give you the `fp` command.
  * If opening for the first time, macOS may warn that it can't be opened 
    because it is from an unidentified 
    developer.&nbsp;<a href="https://gist.github.com/e2tha-e/72364ca766cf5d2d1a732b6af4f3b7a8" target="_blank">*</a>
    * In this case, ctrl+click `fepper.command` and click "Open".
    * In the following prompt, click "Open" to confirm that you're sure you 
      want to open it.
  * Enter your password to allow installation.
  * After installation, Fepper should automatically open in a browser.
  * Open http://localhost:3000 if it doesn't open automatically.

#### CLI install

* In Linux and other Unix-like OSs (or if you prefer working on the command 
  line):
  * Install Node.js if it isn't already installed.
  * `npm install -g fepper-cli`
  * `npm install`
  * `fp`

#### Windows install

* In File Explorer, double-click 
  `fepper.vbs`.&nbsp;<a href="https://gist.github.com/e2tha-e/72364ca766cf5d2d1a732b6af4f3b7a8" target="_blank">*</a>
  * If Node.js is not installed, this will install it.
  * After Node.js installation, double-click `fepper.vbs` again.
    * This will install <a href="https://www.npmjs.com/package/fepper-cli" target="_blank">
      fepper-cli</a>, which will give you the `fp` command.
    * It will then install and launch Fepper.

#### Base install

* Comes with no unnecessary assets, styles, demo website, or 
  <a href="https://www.npmjs.com/package/fp-stylus" target="_blank">fp-stylus</a> 
  extension.
* Node.js must be installed beforehand.
* `npm install -g fepper-cli`
* `npm run install-base`
* `fp`

#### Post-install

* To stop Fepper, go to the command line where Fepper is running and press 
  ctrl+c.

### <a id="configure"></a>Configure

Fepper will run perfectly well out-of-the-box with default configurations. For 
further customization, power-users can edit these files:

* conf.yml
* pref.yml
* patternlab-config.json

Edit `conf.yml` to suit the needs of your development environment. If using Git, 
`conf.yml` will not be version controlled by default.
{'fraction_non_alphanumeric': 0.14511396975851953, 'fraction_numerical': 0.012186865267433988, 'mean_word_length': 4.417481662591687, 'pattern_counts': {'":': 0, '<': 49, '<?xml version=': 0, '>': 49, 'https://': 22, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7671653', 'n_tokens_mistral': 3049, 'n_tokens_neox': 2859, 'n_words': 794}