Giter VIP home page Giter VIP logo

badwords's Introduction

๐Ÿคฌ Badwords

A community based multilanugal badwords database and detection api

What do you mean by Community Based?

This repo is mostly dependent upon pull requests from the contributers to improve the accuracy of the api.

  • you can use it as database of badwords and implement your own filter functions
  • you can use it as api for your app in development enviroment (Host it on your own for production apps) but still can handle good ammount of traffic

API

badwords has some cool api endpoint to intreact with the documentation (not compeleted yet) can be find here

Base urls

hosted on vercel and deta for now

https://badwords.deta.dev/api > https://badwords.vercel.app/api

  • / the information about api
  • /langs information about languages in database
  • /check checks if a words is present in database
  • /listall returns a list of all positives & negatives in the payload specified
  • /clean advanced cleans and returns the payload
  • /simpleclean simple cleans and returns the payload

Options

  • languages array of numbers binded to languages (only specified languages will be check for presence of badword)
  • layers the protection layer of advanced search more the layer more time it takes for response but decreased the chance of missing badwords (currently only 2 supported [1,2])
  • placeholder the replacer to the badword (forced length = 1)
  • exclude the array of words not to check or ignore
  • splitter the splitter for simple clean
  • joiner the joiner of simple clean

Note

  • Advanced clean don't work on Unicode (non-aplhabetical to be specify) instead use simpleClean endpoint

Example

https://badwords.vercel.app/api/clean
{
  "payload": "This is a payload",
  "options": {
    "languages": [0, 1, 2],
    "layers": [1, 2],
    "placeholder": "#"
  }
}

Contributing

Make a pull request after adding few more word cases in the /data/{respectiveFile} more words and languages means more accuracy.

  • the positive array of the datalist has all positive cases
  • the negative array of the datalist has all negative cases for example assassin's

Something to say

Yea ik its a stupid idea for badwords cuz no one really cares but i wanted to make it so i did ๐Ÿ˜‰

badwords's People

Contributors

shivam1608 avatar dependabot[bot] avatar jerbear2008 avatar noobze avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.