GLINR Studio LogoTypeWeaver
Installation

Installation Overview

Choose your preferred installation method for Glin-Profanity across JavaScript, TypeScript, and Python environments

Edit on GitHub

🚀 Universal Library

One API, multiple languages. Get profanity detection running in JavaScript, TypeScript, or Python with 23-language support.

Glin-Profanity offers multiple installation paths tailored to your project needs. Choose the approach that best fits your development workflow:

Quick Start

For immediate setup, here are the most common installation commands:

JavaScript/TypeScript

npm install glin-profanity

Python

pip install glin-profanity

Verification

test.js
import { checkProfanity } from 'glin-profanity';
console.log('✓ Ready:', checkProfanity('test').containsProfanity === false);
test.py
from glin_profanity import Filter
filter = Filter()
print('✓ Ready:', not filter.check_profanity('test')['contains_profanity'])

System Requirements

PlatformMinimum VersionRecommended
Node.js16.0.018.0.0+
Python3.8.03.10.0+
TypeScript4.5.05.0.0+
React16.8.018.0.0+

Installation Methods

Choose the installation approach that best fits your project:

Standard Package Installation

For most projects, use the standard package managers → Package Managers Guide

Framework-Specific Setup

Tailored installation for React, Vue, Next.js, Django, Flask → Framework Integration

Production Deployments

Docker containers, CI/CD pipelines, cloud deployments → Docker & Containers

Browser-Direct Usage

CDN links, no-build setups, vanilla HTML/JS → Browser Installation

Common Installation Patterns

For New Projects

  1. Package Managers - Standard npm/pip installation
  2. Quick Start - Basic setup verification
  3. Configuration - Customize behavior

For Existing Applications

  1. Framework Integration - React, Vue, Django, Flask setups
  2. Server Integration - Production deployment patterns
  3. API Reference - Method documentation

For Production Environments

  1. Docker Setup - Containerized deployments
  2. Config Presets - Production-ready configurations
  3. Dictionary Management - Language updates and customization

Need Help?

Quick Start: Most users should begin with Package Managers followed by the Quick Start Guide.

Framework Users: Jump directly to Framework Integration for React, Vue, Django, or Flask setup.

Production Deployment: See Docker & Containers for production-ready setups.


Next: Choose your installation method above, or continue with Package Managers for the standard setup.