{"id":21994479,"url":"https://github.com/codelibs/fess-site-search","last_synced_at":"2026-05-25T02:05:34.680Z","repository":{"id":53477745,"uuid":"103730861","full_name":"codelibs/fess-site-search","owner":"codelibs","description":"Fess Site Search provides JavaScript files.","archived":false,"fork":false,"pushed_at":"2026-02-09T07:40:57.000Z","size":770,"stargazers_count":24,"open_issues_count":5,"forks_count":9,"subscribers_count":7,"default_branch":"main","last_synced_at":"2026-02-09T13:23:14.196Z","etag":null,"topics":["enterprise-search","fess","google-site-search","javascript","site-search"],"latest_commit_sha":null,"homepage":"https://fss-generator.codelibs.org/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codelibs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-09-16T06:32:39.000Z","updated_at":"2026-02-02T06:08:27.000Z","dependencies_parsed_at":"2024-04-08T00:27:21.809Z","dependency_job_id":"4b5b8d26-ae9b-454d-9df1-f3295e0d4ddd","html_url":"https://github.com/codelibs/fess-site-search","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/codelibs/fess-site-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Ffess-site-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Ffess-site-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Ffess-site-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Ffess-site-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codelibs","download_url":"https://codeload.github.com/codelibs/fess-site-search/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Ffess-site-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29501655,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T05:57:17.024Z","status":"ssl_error","status_checked_at":"2026-02-16T05:56:49.929Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["enterprise-search","fess","google-site-search","javascript","site-search"],"created_at":"2024-11-29T21:09:19.553Z","updated_at":"2026-02-16T06:12:22.275Z","avatar_url":"https://github.com/codelibs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fess Site Search Generator\n\n[![CI/CD Pipeline](https://github.com/codelibs/fess-site-search/actions/workflows/test.yml/badge.svg)](https://github.com/codelibs/fess-site-search/actions/workflows/test.yml)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Python](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/)\n[![Node](https://img.shields.io/badge/node-18+-green.svg)](https://nodejs.org/)\n\nFess Site Search (FSS) is a customizable JavaScript widget generator that enables you to easily embed powerful search functionality on your website, powered by the [Fess](https://fess.codelibs.org/) search engine.\n\n## 🌟 Features\n\n- **Visual Customization Wizard**: Interactive web interface for customizing colors, fonts, and layout\n- **Advanced CSS Support**: Upload custom CSS files for fine-grained control\n- **Live Preview**: See your search widget in action before deployment\n- **Multi-language**: Support for English and Japanese\n- **Vue.js Components**: Modern, responsive search interface built with Vue 3\n- **Easy Integration**: Just one JavaScript file to embed on your site\n\n## 🚀 Quick Start\n\n### Try It Online\n\nVisit [FSS Generator](https://fss-generator.codelibs.org/) to create your customized search widget instantly.\n\n### Run with Docker\n\nThe fastest way to get started:\n\n```bash\n# Build the Docker image\ndocker build -t fss .\n\n# Run the container\ndocker run -d -p 5000:5000 fss\n\n# Access the application\nopen http://localhost:5000\n```\n\n### Local Development Setup\n\n#### Prerequisites\n\n- **Python 3.13** ([Download](https://www.python.org/downloads/))\n- **Node.js 18+** ([Download](https://nodejs.org/))\n- **uv** - Fast Python package installer ([Install](https://github.com/astral-sh/uv))\n\n#### Installation\n\n```bash\n# Install uv (if not already installed)\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n\n# Clone the repository\ngit clone https://github.com/codelibs/fess-site-search.git\ncd fess-site-search\n\n# Run the installation script\nchmod +x install.sh\n./install.sh\n```\n\n#### Running the Development Server\n\n```bash\n# Set Flask environment variable\nexport FLASK_APP=app/__init__.py\n\n# Run with uv\nuv run flask run\n\n# Or activate the virtual environment first\nsource .venv/bin/activate  # On Windows: .venv\\Scripts\\activate\nflask run\n```\n\nThe application will be available at `http://localhost:5000`.\n\n## 📖 Usage\n\n### Generating a Custom Search Widget\n\n1. **Configure Your Fess Server**\n   - Enter your Fess server URL (e.g., `https://search.example.com`)\n\n2. **Customize Appearance**\n   - Choose theme colors (background, text, links, borders)\n   - Select font family\n   - Or upload a custom CSS file\n\n3. **Generate Widget**\n   - Click \"Generate\" to create your customized JavaScript file\n   - Preview the search widget with sample queries\n\n4. **Deploy to Your Site**\n   - Download the generated `fess-ss-{hash}.min.js` file\n   - Add it to your website:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n    \u003ctitle\u003eMy Website\u003c/title\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n    \u003c!-- Your content here --\u003e\n\n    \u003c!-- Fess Site Search Widget --\u003e\n    \u003cdiv id=\"fess-search\"\u003e\u003c/div\u003e\n    \u003cscript src=\"path/to/fess-ss-{hash}.min.js\"\u003e\u003c/script\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\n## 🛠️ Development\n\n### Project Structure\n\n```\nfess-site-search/\n├── app/                    # Flask backend application\n│   ├── views.py           # HTTP route handlers\n│   ├── backend.py         # Form processing and build orchestration\n│   ├── build_manager.py   # Concurrent build process manager\n│   ├── static/            # Static assets (CSS, JS, images)\n│   └── templates/         # Jinja2 HTML templates\n├── fss/                   # Vue.js frontend application\n│   ├── src/               # Vue components and source code\n│   ├── public/            # Public assets\n│   └── package.json       # Node.js dependencies\n├── tests/                 # Test suite\n├── pyproject.toml         # Python project configuration\n├── Dockerfile             # Docker container definition\n└── install.sh             # Installation script\n```\n\n### Available Commands\n\n#### Python/Backend\n\n```bash\n# Install dependencies\nuv sync --all-extras\n\n# Run Flask development server\nuv run flask run\n\n# Run tests\nuv run pytest -v\n\n# Run linter\nuv run ruff check app/ tests/\n\n# Format code\nuv run ruff format app/ tests/\n```\n\n#### Node.js/Frontend\n\n```bash\ncd fss/\n\n# Install dependencies\nnpm install\n\n# Development server with hot-reload\nnpm run serve\n\n# Build for production\nnpm run build\n\n# Lint code\nnpm run lint\n\n# Fix linting issues\nnpm run lint:fix\n```\n\n### Running Tests\n\n```bash\n# Run all tests (excluding slow webpack build tests)\nuv run pytest -v -m \"not slow\"\n\n# Run all tests including slow tests (requires Flask server)\nuv run pytest -v\n\n# Run only slow tests (webpack build tests)\nuv run pytest -v -m \"slow\"\n\n# Run specific test file\nuv run pytest tests/test_status.py -v\n```\n\n**Test Categories:**\n- **Fast tests** (`not slow`): Basic Flask routes and functionality (~5 seconds)\n- **Slow tests** (`slow`): Dynamic webpack builds and uploads (~30-120 seconds)\n\n**Note:** Slow tests require a running Flask server and may take several minutes in CI environments.\n\n### Building for Production\n\n#### Docker Image\n\n```bash\n# Build optimized production image\ndocker build -t fss:latest .\n\n# Run in production mode\ndocker run -d \\\n  -p 5000:5000 \\\n  -e APP_WEBPACK_LIMIT=4 \\\n  --name fss-prod \\\n  fss:latest\n```\n\n#### Manual Build\n\n```bash\n# Build frontend\ncd fss/\nnpm run build\n\n# Copy to Flask static directory\nmkdir -p ../app/static/fss\ncp dist/fess-ss.js ../app/static/fss/\n\n# Run with Gunicorn\ncd ..\nuv run gunicorn app:app \\\n  -b 0.0.0.0:5000 \\\n  -w 4 \\\n  --threads 12 \\\n  --preload\n```\n\n## 🔧 Configuration\n\n### Environment Variables\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `FLASK_APP` | Flask application entry point | `app/__init__.py` |\n| `FLASK_ENV` | Flask environment (`development`/`production`) | `production` |\n| `APP_WEBPACK_LIMIT` | Maximum concurrent webpack builds | `2` |\n\n### Build Configuration\n\nThe application supports concurrent build processes with semaphore-based throttling. Adjust `APP_WEBPACK_LIMIT` based on your server resources:\n\n- **Small instances** (1-2 CPU cores): `APP_WEBPACK_LIMIT=2`\n- **Medium instances** (4-8 CPU cores): `APP_WEBPACK_LIMIT=4`\n- **Large instances** (8+ CPU cores): `APP_WEBPACK_LIMIT=8`\n\n## 📚 Documentation\n\n- **[User Manual](https://fss-generator.codelibs.org/docs/manual)**: Complete guide for using FSS Generator\n- **[Technical Specifications](./SPECIFICATIONS.md)**: Detailed technical documentation\n- **[Fess Documentation](https://fess.codelibs.org/)**: Learn about the Fess search engine\n\n## 🤝 Contributing\n\nContributions are welcome! Please follow these steps:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Make your changes\n4. Run tests (`uv run pytest -v`)\n5. Run linter (`uv run ruff check . \u0026\u0026 uv run ruff format .`)\n6. Commit your changes (`git commit -m 'Add amazing feature'`)\n7. Push to the branch (`git push origin feature/amazing-feature`)\n8. Open a Pull Request\n\n## 🐛 Bug Reports\n\nIf you find a bug, please create an issue on [GitHub Issues](https://github.com/codelibs/fess-site-search/issues) with:\n\n- Clear description of the problem\n- Steps to reproduce\n- Expected vs actual behavior\n- Environment details (OS, Python version, Node.js version)\n\n## 📄 License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- **[Fess](https://fess.codelibs.org/)**: Powerful enterprise search engine\n- **[Vue.js](https://vuejs.org/)**: Progressive JavaScript framework\n- **[Flask](https://flask.palletsprojects.com/)**: Lightweight web framework\n\n## 📞 Support\n\n- **Website**: [fss-generator.codelibs.org](https://fss-generator.codelibs.org/)\n- **Documentation**: [User Manual](https://fss-generator.codelibs.org/docs/manual)\n- **Issues**: [GitHub Issues](https://github.com/codelibs/fess-site-search/issues)\n- **Email**: support@n2sm.net\n\n---\n\n**Made with ❤️ by [CodeLibs Project](https://www.codelibs.org/)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodelibs%2Ffess-site-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodelibs%2Ffess-site-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodelibs%2Ffess-site-search/lists"}