# zally-web-ui

> Zally API Linter Web UI

Latest version **0.1.1** (published 2017-05-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install zally-web-ui
pnpm add zally-web-ui
yarn add zally-web-ui
bun add zally-web-ui
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2017-05-18 |
| First published | 2017-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.6 |
| Dependencies | 11 |
| Known vulnerabilities | 0 (+14 in 3 direct dependencies) |
| Install scripts | no |
| Maintainers | rbarilani |
| Keywords | API, Linter, Zally |

## Links

- npm: https://www.npmjs.com/package/zally-web-ui
- Repository: https://github.com/zalando-incubator/zally-web-ui
- Homepage: https://github.com/zalando-incubator/zally-web-ui#readme
- Issues: https://github.com/zalando-incubator/zally-web-ui/issues
- npm.io page: https://npm.io/package/zally-web-ui

## Dependencies (11)

- [pug](https://npm.io/package/pug.md) 2.0.0-rc.1
- [react](https://npm.io/package/react.md) 15.4.2
- [lodash](https://npm.io/package/lodash.md) 4.17.4
- [express](https://npm.io/package/express.md) 4.15.2
- [history](https://npm.io/package/history.md) 3.0.0
- [react-ace](https://npm.io/package/react-ace.md) 4.2.0
- [react-dom](https://npm.io/package/react-dom.md) 15.4.2
- [dress-code](https://npm.io/package/dress-code.md) 2.0.0
- [react-router](https://npm.io/package/react-router.md) 3.0.4
- [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) 2.0.3
- [aurelia-fetch-client](https://npm.io/package/aurelia-fetch-client.md) 1.1.2

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2017-05-18
- 0.1.0 — 2017-05-18

## README

[![dependencies Status](https://david-dm.org/zalando-incubator/zally-web-ui/status.svg)](https://david-dm.org/zalando-incubator/zally-web-ui)
[![codecov](https://codecov.io/gh/zalando-incubator/zally-web-ui/branch/master/graph/badge.svg)](https://codecov.io/gh/zalando-incubator/zally-web-ui)

Zally WEB-UI
============

Zally Web-UI project provides a web user interface to lint your api specs.


## Requirements

* NodeJS >= 7.6

## Install

```bash
npm install zally-web-ui --save
```

## Usage

### Basic

```js
const app = require('zally-web-ui')();

app.listen(3000, () => {
  console.log('zally-web-ui running at http://localhost:3000');
});
```

### Mount to an existing application

```js
const app = require('express')()
const zally = require('zally-web-ui')(/*options*/);

app.use('/api-linter', zally);
app.listen(3000, () => {
  console.log('server running at http://localhost:3000');
});
```

## Configuration options

When instantiating the app you can pass an `options` object to customize the behavior. 

```js
const options = { /* ..my options.. */}
const zally = require('zally-web-ui')(options);
```

### Options

* **windowEnv**: the windowEnv `object` contains all the values exposed to the client on `window.env` 
* **windowEnv.OAUTH_ENABLED** (default: `false`): enable OAuth or just Auth support on the client side (an http call will be fired on `/auth/me` endpoint to get the current logged in user, if any)  
* **windowEnv.ZALLY_API_URL** (default: `http://localhost:8080`): URL pointing to Zally REST API
* **windowEnv.DEBUG** (default: `true`): logs debugging message on the client side
* **logger** (default: `console`): custom logger
* **handlers**: the handlers `object` contains all route handlers used by zally-web-ui
* **handlers.assets**: handler that serve static assets
* **handlers.windowEnv**: handler that serve `/env.js` javascript file used to expose `windowEnv` values to the client on `window.env`
* **handlers.index**: handler that serve the single page application entrypoint on the wild card `*` to allow HTML5 History API working as expected

## Development

### Install, build and run in development mode

```
cd web-ui
npm install
npm run dev
```

> The `npm run dev` task starts the application server in development mode with **nodemon** and **webpack-dev-server** watching for changes.<br>
  The application server acts as a proxy to webpack-dev-server as the target.

### Run in production mode

```
npm run build
npm start
```

### Build optimized client javascript bundle

Build webpack bundle minified and source-map file(s).

```
npm run build
```

## Contributing

People interested contributing to the web-ui project can open issues and related pull requests. 

Before opening PRs, be sure the test are running by executing `npm test`.

### Contact

Feel free to contact one the [maintainers](MAINTAINERS)

### License

MIT license with an exception. See [license file](LICENSE).

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