# @agreed/ui

> UI for [Agreed](https://www.npmjs.com/package/agreed-core)

Latest version **6.0.0** (published 2024-03-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @agreed/ui
pnpm add @agreed/ui
yarn add @agreed/ui
bun add @agreed/ui
```

Provides the command `agreed-ui`.

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2024-03-14 |
| First published | 2019-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 (+7 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 215 |
| Author | yosuke-furukawa |
| Maintainers | yosuke-furukawa, maxmellon |
| Keywords | agreed, ui |

## Links

- npm: https://www.npmjs.com/package/@agreed/ui
- Repository: https://github.com/recruit-tech/agreed
- Homepage: https://github.com/recruit-tech/agreed-ui
- Issues: https://github.com/recruit-tech/agreed/issues
- npm.io page: https://npm.io/package/@agreed/ui

## Dependencies (9)

- [colo](https://npm.io/package/colo.md) 1.0.0
- [express](https://npm.io/package/express.md) 4.18.2
- [fs-extra](https://npm.io/package/fs-extra.md) 11.1.0
- [minimist](https://npm.io/package/minimist.md) 1.2.8
- [@agreed/core](https://npm.io/package/@agreed/core.md) ^6.0.0
- [lodash.template](https://npm.io/package/lodash.template.md) 4.5.0
- [serialize-javascript](https://npm.io/package/serialize-javascript.md) 6.0.1
- [json-schema-to-flow-type](https://npm.io/package/json-schema-to-flow-type.md) 1.0.0
- [@babel/plugin-proposal-private-property-in-object](https://npm.io/package/@babel/plugin-proposal-private-property-in-object.md) ^7.21.11

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 6.0.0 (latest) — 2024-03-14
- 5.3.2-alpha.0 — 2022-08-25
- 5.3.1 — 2022-08-16
- 5.3.0 — 2022-07-21
- 5.2.1 — 2021-07-06
- 5.2.0 — 2021-01-29
- 5.1.10 — 2020-09-01
- 5.1.9 — 2020-08-07
- 5.1.8 — 2020-08-03
- 5.1.7 — 2020-05-28
- 5.1.6 — 2020-05-27
- 5.1.5 — 2020-04-06
- 5.1.4 — 2020-04-06
- 5.1.3 — 2020-03-30
- 5.1.2 — 2020-03-30
- … 13 more at https://npm.io/package/@agreed/ui/versions

## README

# Agreed UI

UI for [Agreed](https://www.npmjs.com/package/agreed-core)

![ScreenShot](https://raw.githubusercontent.com/recruit-tech/agreed-ui/master/screenshot.png)

# Install

```
$ npm install agreed-ui --save-dev
```

# Usage

```
$ agreed-ui --path ./test/agreed.json --port 3000
```
Serve with [Express](https://www.npmjs.com/package/express)
Open http://localhost:3000 to view it in the browser.

```
$ agreed-ui build --path ./test/agreed.json --dest ./build
```
Builds the app for static-hosting to the build folder

# Features

## Set title and description to contract

```
{
  title: 'get store information',
  description: 'get store information',
  request: {
    ...
  },
  response: {
    ...
  }
}
```

title and descripion will be displayed at naviation and each section's title

# Development

`npm run start:dev -- --path=./test/agrees/agrees.js `

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