Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/selvin-paul-raj/spr_censorify_example

Enhance content integrity using CustomCensorify: a JavaScript module. Efficiently replace sensitive words for respectful communication. Code and example included.
https://github.com/selvin-paul-raj/spr_censorify_example

censor censored-data nodejs npm-package

Last synced: 18 days ago
JSON representation

Enhance content integrity using CustomCensorify: a JavaScript module. Efficiently replace sensitive words for respectful communication. Code and example included.

Awesome Lists containing this project

README

        

[![npm version](https://badge.fury.io/js/angular2-expandable-list.svg)](https://badge.fury.io/js/angular2-expandable-list)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

# SPR_Censorify_Example

> Enhance content integrity using CustomCensorify: a JavaScript module. Efficiently replace sensitive words for respectful communication. Code and example included.

## Prerequisites

This project requires NodeJS (version 8 or later) and NPM.
[Node](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.
To make sure you have them available on your machine,
try running the following command.

```sh
$ npm -v && node -v
9.8.1
v20.5.0
```

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

## Installation

**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)

Start with cloning this repo on your local machine:

```sh
$ git clone https://github.com/SPRHackz/spr_censorify_Example.git
$ cd spr_censorify_Example
```

To install and set up the library, run:

```sh
$ npm install sprhackz-censorify
```

Or if you prefer using Yarn:

```sh
$ yarn add sprhackz-censorify
```

## Usage

### Serving the app

```sh
$ npm start
```

## Authors

* **Selvin PaulRaj** - *Initial work* - [SPR Hackz](https://github.com/SPRHackz)