{"id":37224526,"url":"https://github.com/arnonsang/badwords","last_synced_at":"2026-01-15T01:42:06.697Z","repository":{"id":245524593,"uuid":"818515698","full_name":"arnonsang/badwords","owner":"arnonsang","description":"A simple and lightweight API for filtering and checking bad words, built with Go and Echo.","archived":false,"fork":false,"pushed_at":"2024-07-25T15:44:09.000Z","size":6147,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-07-25T18:11:22.115Z","etag":null,"topics":["badwords","badwordsfilter","content-filtering","docker","echo","echo-framework","go","golang"],"latest_commit_sha":null,"homepage":"https://badwords.iamickdev.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arnonsang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-22T03:52:33.000Z","updated_at":"2024-07-25T15:44:13.000Z","dependencies_parsed_at":"2024-07-07T16:10:13.845Z","dependency_job_id":null,"html_url":"https://github.com/arnonsang/badwords","commit_stats":null,"previous_names":["arnonsang/badwords"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/arnonsang/badwords","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnonsang%2Fbadwords","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnonsang%2Fbadwords/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnonsang%2Fbadwords/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnonsang%2Fbadwords/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arnonsang","download_url":"https://codeload.github.com/arnonsang/badwords/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnonsang%2Fbadwords/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28441031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-15T00:55:22.719Z","status":"ssl_error","status_checked_at":"2026-01-15T00:55:20.945Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["badwords","badwordsfilter","content-filtering","docker","echo","echo-framework","go","golang"],"created_at":"2026-01-15T01:42:05.773Z","updated_at":"2026-01-15T01:42:06.684Z","avatar_url":"https://github.com/arnonsang.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Simple Bad Word Checker\n\n![Logo](static/favicon-32x32.png)\n\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![GitHub stars](https://img.shields.io/github/stars/arnonsang/badwords.svg?style=social)](https://github.com/arnonsang/badwords/stargazers) [![GitHub issues](https://img.shields.io/github/issues/arnonsang/badwords.svg)](https://github.com/arnonsang/badwords/issues) ![GitHub pull requests](https://img.shields.io/github/issues-pr/arnonsang/badwords.svg)\n\nA simple and lightweight API for filtering and checking bad words, built with [Go](https://go.dev/) and [Echo](https://echo.labstack.com/).\n\n[Features](#-features) • [Usage](#-usage) • [Installation](#-installation) • [API](#api-endpoints) • [Todo](#-to-do-list) • [Contributing](#-contributing) • [Acknowledgments](#-acknowledgments) • [License](#license)\n\n![Screenshot](static/screenshot.png)\n\n\u003c/div\u003e\n\n## 🌟 Features\n\n- 📋 Retrieve a comprehensive list of bad words via API\n- ✅ Check if a specific word is considered inappropriate\n- 🌐 User-friendly web interface for easy testing and usage\n- 🐳 Docker support for simple deployment\n\n## 🚀 Usage\n\n### API Endpoints\n\n| Method | Endpoint                  | Description                                       |\n| ------ | ------------------------- | ------------------------------------------------- |\n| GET    | `/healthz`                | Health check endpoint                             |\n| GET    | `/api/words`              | Get a list of bad words                          |\n| GET    | `/api/word/:word`         | Check if a word is a bad word                    |\n| GET    | `/api/sentence/:sentence` | Check if a sentence contains bad words            |\n| POST   | `/api/sentence`           | Check if a sentence contains bad words            |\n| GET    | `/api/replacer/:sentence` | Replace bad words in a sentence                   |\n| POST   | `/api/replacer`           | Replace bad words in a sentence                   |\n\n\n\n### Web Interface\n\nAccess the intuitive web interface by navigating to [badword.iamickdev.com](https://badwords.iamickdev.com)\n\n\n## 📝 TODO List\n\n| Task                           | Status          | Description                               |\n|--------------------------------|-----------------|-------------------------------------------|\n| Migrate static word set to database   | ⚙️ In Progress   | Move the static word set to a database for better management and scalability |\n| Create endpoint to let everyone can add more word   | ⚙️ In Progress  | Implement an API endpoint to allow users to add additional bad words dynamically |\n| Add languages detector and support more languages   | 🟡 Pending     | Integrate language detection to support filtering bad words in multiple languages |\n\n\n## 💻 Installation\n\n1. Clone this repository:\n```bash\ngit clone https://github.com/arnonsang/badwords.git\n```\n2. Navigate to the project directory:\n```bash\ncd your_project_dir\n```\n3. Build and run via docker compose:\n```bash\nmake up\n```\n4. Access the application at `http://localhost:8089` in your browser.\n\n## ⚙️ Makefile Commands\n\n| Command | Description |\n|---------|-------------|\n| `make build` | Builds the Docker image |\n| `make up` | Starts the application using Docker Compose |\n| `make up-detached` | Starts the application in detached mode |\n| `make down` | Stops and removes the containers |\n| `make clean` | Removes the Docker image |\n| `make restart` | Restarts the application |\n| `make logs` | Tails the logs of the running containers |\n| `make status` | Shows the status of the running containers |\n\n## 📦 Dependencies\n\n- [Go](https://golang.org/) - The programming language powering the server\n- [Echo](https://echo.labstack.com/) - High performance, extensible, minimalist Go web framework\n- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework for rapid UI development\n\n## 📁 Project Structure\n```bash\n├── assets\n│   └── badwords.go\n├── docker-compose.yml\n├── Dockerfile\n├── go.mod\n├── go.sum\n├── LICENSE\n├── main.go\n├── Makefile\n├── presentation\n│   └── server.go\n├── README.md\n├── static\n│   ├── android-chrome-192x192.png\n│   ├── android-chrome-512x512.png\n│   ├── apple-touch-icon.png\n│   ├── favicon-16x16.png\n│   ├── favicon-32x32.png\n│   ├── favicon.ico\n│   ├── images\n│   │   └── github-mark.svg\n│   ├── index.html\n│   ├── screenshot.png\n│   └── site.webmanifest\n└── usecase\n    └── badwords.go\n```\n\n## 🎉 Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/arnonsang/badwords/issues) or open [pull request](https://github.com/arnonsang/badwords/pulls).\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\nWe'd like to tip our hats to:\n\n- The awesome folks at **[favicon.io](https://favicon.io/favicon-generator/)** for their fantastic favicon generator. It's made our app look snazzy!\n- The brilliant minds at **[Carnegie Mellon University](https://www.cs.cmu.edu/~biglou/resources/bad-words.txt)** for providing a comprehensive list of bad words. Your work helps keep the internet a little cleaner!\n\nYour resources have been invaluable in making this project shine. Thank you! 🌟\n\n## Author\n\nMade with ❤️ by **[iamickdev](https://www.iamickdev.com)**\n- Website: [www.iamickdev.com](https://www.iamickdev.com)\n- Github: [@arnonsang](https://github.com/arnonsang)\n\n---\n\n**From JLR Lab**  \n*A Gen Z technology research, consulting and development team based in Thailand.*\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farnonsang%2Fbadwords","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farnonsang%2Fbadwords","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farnonsang%2Fbadwords/lists"}