License Version JavaScript PRs Welcome
๐งฌ A powerful, intelligent search module designed specifically for RNA aptamer databases and bioinformatics research platforms.
- ๐ Smart Search Algorithm: Advanced relevance scoring with multi-field search capabilities
- โก Real-time Search: Instant results with <100ms response time
- ๐ฏ Advanced Filtering: Filter by year, sequence length, GC content, and more
- ๐ก Keyword Highlighting: Automatic search term highlighting in results
- ๐ฑ Responsive Design: Perfect adaptation for desktop and mobile devices
- ๐ Multi-source Support: Unified search across Jekyll pages and sequence databases
- ๐ Easy Integration: 3-line code integration for basic functionality
๐ View Live Demo
Try searching for:
ATP aptamerthrombinSELEXbinding affinity
# Download the latest release wget https://github.com/OOAAHH/ribocentre-search-module/releases/latest/download/ribocentre_search_module_v2.0.zip # Extract files unzip ribocentre_search_module_v2.0.zip
git clone https://github.com/OOAAHH/ribocentre-search-module.git
cd ribocentre-search-module<!-- CSS --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/OOAAHH/ribocentre-search-module@2.0.0/css/search.css"> <!-- JavaScript --> <script src="https://cdn.jsdelivr.net/gh/OOAAHH/ribocentre-search-module@2.0.0/js/search-utils.js"></script> <script src="https://cdn.jsdelivr.net/gh/OOAAHH/ribocentre-search-module@2.0.0/js/search.js"></script>
<!DOCTYPE html> <html> <head> <!-- 1. Include CSS --> <link rel="stylesheet" href="css/search.css"> </head> <body> <!-- 2. Add search input --> <input type="text" id="mainSearch" placeholder="Search RNA aptamers..."> <!-- 3. Include JavaScript --> <script src="js/search-utils.js"></script> <script src="js/search.js"></script> <script> document.addEventListener('DOMContentLoaded', () => { SearchModule.init(); }); </script> </body> </html>
<!-- Include advanced search module --> <script src="js/advanced-search.js"></script> <link rel="stylesheet" href="css/advanced-search.css"> <script> // Initialize advanced search const advancedSearch = new AdvancedSearchModule(); </script>
ribocentre-search-module/
โโโ ๐ README.md # You are here
โโโ ๐ search_module_documentation.md # Complete technical documentation
โโโ ๐ js/ # Core JavaScript modules
โ โโโ ๐ search.js # Main search module
โ โโโ ๐ ๏ธ search-utils.js # Search utilities
โ โโโ โ๏ธ advanced-search.js # Advanced search features
โ โโโ ๐ homepage-main.js # Homepage search integration
โโโ ๐ css/ # Stylesheets
โ โโโ ๐จ search.css # Search interface styles
โโโ ๐ pages/ # Page templates
โ โโโ ๐ advanced_search.html # Advanced search page
โโโ ๐ includes/ # Reusable components
โ โโโ ๐งฉ search-box.html # Search box component
โโโ ๐ data/ # Sample data files
โ โโโ ๐ search.json # Search index data
โ โโโ ๐งฌ sequences_sample.json # Sequence data sample
โโโ ๐ docs/ # Technical documentation
โ โโโ ๐ search_functionality.txt # Detailed functionality guide
โ โโโ ๐ง SEARCH_FIX_README.txt # Search fixes documentation
โโโ ๐ examples/ # Usage examples
โโโ ๐ฎ basic_search_demo.html # Interactive demo
โโโ ๐ integration_guide.md # Integration guide
// Configure search behavior window.SEARCH_CONFIG = { disableHeroHeightFix: false, // Disable page height fixing searchDelay: 300, // Search delay in milliseconds minSearchLength: 2 // Minimum search character length }; // Configure data sources window.DASHBOARD_CONFIG = { dataPath: '/api/search.json', // Custom search data path baseurl: '/your-app' // Application base URL };
| Field | Application |
|---|---|
| ๐งฌ Bioinformatics | RNA/DNA sequence search, protein databases |
| ๐ฌ Academic Research | Literature search, paper databases |
| ๐ฅ Medical Research | Drug databases, clinical data search |
| ๐ Digital Libraries | Document search, content management |
| ๐๏ธ Museums | Artifact catalogs, collection databases |
- โก Response Time: <100ms average
- ๐ Scalability: 1000+ records real-time search
- ๐พ Memory: Optimized memory usage with caching
- ๐ Compatibility: All modern browsers (95%+ coverage)
// Initialize search module SearchModule.init(); // Perform programmatic search SearchModule.performSearchWithQuery('ATP aptamer'); // Get current search results const results = SearchModule.allSearchResults; // Close search results SearchModule.closeSearchResults();
// Listen to search events document.addEventListener('searchStart', (event) => { console.log('Search started:', event.detail.query); }); document.addEventListener('searchComplete', (event) => { console.log('Search completed:', event.detail.results); });
# Run the demo open examples/basic_search_demo.html # Test different scenarios # 1. Basic search: "ATP" # 2. Complex search: "RNA aptamer thrombin" # 3. Advanced filters: Year range, sequence length
- ๐ Complete Technical Documentation - Full system architecture
- ๐ ๏ธ Integration Guide - Step-by-step integration
- ๐ฎ Live Demo - Interactive demonstration
- ๐ง API Reference - Detailed API documentation
We welcome contributions! Please see our Contributing Guidelines for details.
# Clone the repository git clone https://github.com/OOAAHH/ribocentre-search-module.git cd ribocentre-search-module # Start development server (if you have one) # npm start # or your preferred method # Make your changes and test open examples/basic_search_demo.html
- ๐ Bug Reports: Report issues
- โจ Feature Requests: Suggest enhancements
- ๐ Documentation: Improve docs and examples
- ๐งช Testing: Add test cases and improve coverage
- ๐ Translations: Help translate to other languages
We use SemVer for versioning. For available versions, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE file for details.
- ๐ Documentation: Check our comprehensive docs first
- ๐ Bug Reports: Create an issue
- ๐ฌ Discussions: GitHub Discussions
- ๐ง Email: contact@ribocentre-aptamer.org
- ๐งฌ Ribocentre-Aptamer Team - Original project development
- ๐ฌ Academic Community - Research and feedback
- ๐ป Open Source Community - Inspiration and best practices
GitHub stars GitHub forks GitHub issues GitHub last commit
- ๐งฌ Ribocentre-Aptamer - Main aptamer database
- ๐ Jekyll Simple Search - Alternative Jekyll search
- ๐ Lunr.js - Client-side full-text search
If you use this search module in your research, please cite:
@software{ribocentre_search_module, author = {Ribocentre-Aptamer Team}, title = {Ribocentre-Aptamer Search Module: Intelligent Search for Bioinformatics Databases}, year = {2024}, url = {https://github.com/OOAAHH/ribocentre-search-module}, version = {2.0.0} }
โญ If you find this project useful, please give it a star! โญ
Made with โค๏ธ by the Ribocentre-Aptamer Team