# tempaw-express

> Development Express server for simple html sites

Latest version **1.0.3** (published 2022-09-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install tempaw-express
pnpm add tempaw-express
yarn add tempaw-express
bun add tempaw-express
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-09-23 |
| First published | 2022-09-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | TmHtmlDept |
| Maintainers | zemez-tm |
| Keywords | tempaw, browser-sync, express, server, sass, pug |

## Links

- npm: https://www.npmjs.com/package/tempaw-express
- Repository: https://github.com/TmHtmlDept/tempaw-express
- Homepage: https://github.com/TmHtmlDept/tempaw-express#readme
- Issues: https://github.com/TmHtmlDept/tempaw-express/issues
- npm.io page: https://npm.io/package/tempaw-express

## Dependencies (5)

- [pug](https://npm.io/package/pug.md) 2.0.4
- [gulp](https://npm.io/package/gulp.md) 4.0.2
- [sass](https://npm.io/package/sass.md) 1.32.8
- [express](https://npm.io/package/express.md) 4.17.1
- [browser-sync](https://npm.io/package/browser-sync.md) 2.26.7

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2022-09-23

## README

# Oxyz Express
Express server for simple HTML projects.

## Usage
Simple step-by-step guide:
- Create a _*.js_ file in the project’s root folder (e.g. _server.js_).
- Import the _oxyz-express_ module.
- Call the function with the required parameters.
- Launch the file from the console (`node server.js`)

Here’s an example:
```js
let server = require( 'oxyz-express' );
server({
  // Your parameters
});
```

## Parameters
Below you can find the default parameter object.
```js
{
  express: {                      // Settings of express
    root: './dev/',               // Root folder
    port: 3000,                   // The port of express server
    static: [                     // Static path list
      [ 'dev' ]                   // Request path and project folder path
    ]
  },
  browserSync: {                  // browsersync settings (see. https://browsersync.io/docs/options)
    port: 8000,
    proxy: 'localhost:3000',
    open: false,
    notify: true,
    reloadDelay: 0,
    ui: false,
    ghostMode: {
      clicks: false,
      forms: false,
      scroll: false
    }
  },
  watcher: {                      // gulp-watcher settings to track the file changes
    enable: true,                 // Enabled or disabled
    globs: [ 'dev/**/*.js' ]      // File selection array for tracking (see. https://www.npmjs.com/package/glob)
  },
  pug: {                          // Settings of pug template engine
    enable: true,                 // Enabled or disabled
    index: 'index',               // Index page title (without extension)
    root: 'dev/components/page',  // Root folder for the page search
    globs: [ 'dev/**/*.pug' ],    // File selection array for tracking (see. https://www.npmjs.com/package/glob)
    options: {                    // Template engine parameters, not all options can be applied (see. https://pugjs.org/api/reference.html)
      doctype: 'html',
      pretty: true,
      self: true
    }
  },
  sass: {                         // Sass preprocessor settings
    enable: true,                 // Enabled or disabled
    root: 'dev/components',       // Root folder for the stylesheet search
    globs: [ 'dev/**/*.scss' ],   // File selection array for tracking (see. https://www.npmjs.com/package/glob)
    options: {                    // Preprocessor parameters, not all options can be applied (see. https://github.com/sass/node-sass#options)
      outputStyle: 'expanded'
    }
  },
  cb: null                        // Callback for additional request handler, gets the `app` parameter, no need to return anything (see. http://expressjs.com/en/4x/api.html#app.get.method)
}
```

---
_Source: https://npm.io/package/tempaw-express · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._