Installation Overview
Choose your preferred installation method for Glin-Profanity across JavaScript, TypeScript, and Python environments
🚀 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:
📦 Package Managers
Standard npm, yarn, pnpm, pip, poetry installation
⚛️ Framework Integration
React, Vue, Next.js, Express, Django, Flask setups
🐳 Docker & Containers
Containerized deployments and CI/CD pipelines
🔗 CDN & Browser
Direct browser usage without build tools
Quick Start
For immediate setup, here are the most common installation commands:
JavaScript/TypeScript
npm install glin-profanityPython
pip install glin-profanityVerification
import { checkProfanity } from 'glin-profanity';
console.log('✓ Ready:', checkProfanity('test').containsProfanity === false);from glin_profanity import Filter
filter = Filter()
print('✓ Ready:', not filter.check_profanity('test')['contains_profanity'])System Requirements
| Platform | Minimum Version | Recommended |
|---|---|---|
| Node.js | 16.0.0 | 18.0.0+ |
| Python | 3.8.0 | 3.10.0+ |
| TypeScript | 4.5.0 | 5.0.0+ |
| React | 16.8.0 | 18.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
- Package Managers - Standard npm/pip installation
- Quick Start - Basic setup verification
- Configuration - Customize behavior
For Existing Applications
- Framework Integration - React, Vue, Django, Flask setups
- Server Integration - Production deployment patterns
- API Reference - Method documentation
For Production Environments
- Docker Setup - Containerized deployments
- Config Presets - Production-ready configurations
- 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.