https://github.com/servable-community/servable-reviewable

The reviewable protocol handles the complete review state of an object.
https://github.com/servable-community/servable-reviewable

protocol servable

Last synced: about 1 month ago
JSON representation

The reviewable protocol handles the complete review state of an object.

• Host: GitHub
• URL: https://github.com/servable-community/servable-reviewable
• Owner: servable-community
• License: mit
• Created: 2023-09-29T18:32:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-01T19:55:30.000Z (12 months ago)
• Last Synced: 2024-12-10T00:32:01.044Z (about 1 month ago)
• Topics: protocol, servable
• Language: JavaScript
• Homepage:
• Size: 233 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Reviewable Protocol

![logo](/static/img/polar-bear-4.png)

[![npm Package](https://img.shields.io/npm/v/servable-reviewable.svg?style=flat-square)](https://www.npmjs.org/package/servable-reviewable)

[![NPM Downloads](https://img.shields.io/npm/dm/servable-reviewable.svg)](https://npmjs.org/package/servable-reviewable)

[![Build Status](https://github.com/yelounak/servable-reviewable/actions/workflows/release.yml/badge.svg)](https://github.com/yelounak/servable-reviewable/actions/tests.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

The reviewable protocol handles the complete publication state of an object.

## Install

```bash

yarn add servable-reviewable

```

## Auxiliary packages

### Shared library

[servable-reviewable-shared](https://github.com/yelounak/servable-reviewable-shared)

```bash

yarn add servable-reviewable-shared

```

### React library

[servable-reviewable-react](https://github.com/yelounak/servable-reviewable-react)

```bash

yarn add servable-reviewable-react

```

## Protocol

### Configuration

#### Payload sample

```json

 {

    "id": "reviewable",

    "name": "reviewable",

    "slug": "ps",

    "module": {

        "servable-reviewable": "*"

    },

    "version": "*",

    "params": {

        "liveClasses": ["reviewable"],

        "schema": {

            "restrictSecurity": true

        }

    }

}

```

#### Reference

### Capacities

#### Schema

**Classes**

TODO

**Class level permissions**

TODO

**Indexes**

```json

{

    "_reviewableStatus": {

        "reviewableStatus": 1

    }

}

```

**Fields**

```json

{

    "reviewableStatus": {

        "type": "String"

    }

}

```

#### Protocol class

TODO

#### Classes

TODO

#### Triggers

TODO

#### Before init

TODO

#### After init

TODO

#### Seed

TODO

#### Config

TODO

#### Functions

TODO

#### Jobs

TODO

#### Live classes

TODO

### Security

TODO

### Performance

TODO

## Servable Documentation

You can find here the complete [servable documentation](https://docs.servable.app/) with guides and api reference.

## License

MIT © [yelounak](https://github.com/yelounak)