Development

Resources for developers: the developer guide, the source code and Docker images, the API references, the roadmap, and issue tracking.

Developer Guide

• Target Audience
• Required Prerequisites
• Development Guide Structure
• Quick Start
• Development Environment Options
  • Local Development Environment
  • Docker-Based Development Environment
• Frequently Asked Questions
  • Q: What are the minimum specifications required for development?
  • Q: Which IDE should I use?
  • Q: Is knowledge of LastaFlute and DBFlute required?
  • Q: What should I start with for my first contribution?
• Related Resources
  • Official Resources
  • Technical Documentation
  • Community
• Next Steps
  • Open Source Full-text Search Server - Fess Development Overview
    • Overview
      • Fess Features
    • Technology Stack
      • Target Versions
      • Main Technologies and Frameworks
        • Java 21
        • LastaFlute
        • DBFlute
        • OpenSearch
        • Maven
    • Development Tools
      • Recommended Development Environment
        • Eclipse
        • IntelliJ IDEA
        • VS Code
        • Version Control
    • Required Knowledge
      • Basic Knowledge
      • Learning Resources
        • Official Documentation
        • Community
        • Source Code
    • Basic Development Flow
    • Project Structure Overview
      • Main Packages
        • app
        • crawler
        • opensearch
        • helper
        • job
    • Development Environment Quick Start
      • Prerequisites
      • Steps
    • Development Tips
      • Debug Execution
      • Hot Deploy
      • Checking Logs
      • Operating OpenSearch
    • Community and Support
      • Questions and Consultation
      • How to Contribute
    • Next Steps
    • References
      • Official Resources
      • Technical Documentation
      • Community
  • Development Environment Setup
    • System Requirements
      • Hardware Requirements
      • Software Requirements
    • Installing Required Software
      • Installing Java
        • Installing Eclipse Temurin (Recommended)
        • Verifying Installation
        • Setting Environment Variables
      • Installing Maven
        • Download and Installation
        • Setting Environment Variables
        • Verifying Installation
      • Installing Git
    • IDE Setup
      • For Eclipse
        • Installing Eclipse
        • Recommended Plugins
        • Importing the Project
        • Setting Run Configuration
      • For IntelliJ IDEA
        • Installing IntelliJ IDEA
        • Importing the Project
        • Setting Run Configuration
      • For VS Code
        • Installing VS Code
        • Installing Required Extensions
        • Opening the Project
    • Obtaining Source Code
      • Cloning from GitHub
    • Building the Project
      • Downloading OpenSearch Plugins
      • Initial Build
    • Running Fess
      • Running from Command Line
      • Running from IDE
        • For Eclipse
        • For IntelliJ IDEA
        • For VS Code
      • Verifying Startup
      • Changing the Port Number
    • Debug Execution
      • Debug Execution in IDE
        • For Eclipse
        • For IntelliJ IDEA
        • For VS Code
      • Remote Debugging
    • Useful Development Settings
      • Changing Log Level
      • Enabling Hot Deploy
      • Operating Embedded OpenSearch
      • Using External OpenSearch
    • Code Generation with DBFlute
      • Regenerating When Schema Changes
    • Troubleshooting
      • Build Errors
      • Runtime Errors
      • Project Not Recognized in IDE
    • Next Steps
    • Resources
  • Architecture and Code Structure
    • Overall Architecture
      • Layer Descriptions
        • User Interface Layer
        • Web Application Layer
        • Business Logic Layer
        • Data Access Layer
        • Data Store Layer
    • Project Structure
      • Directory Structure
    • Main Package Details
      • app Package
        • app.web Package
        • app.web.admin Package
        • app.service Package
      • crawler Package (fess-crawler library)
        • crawler Package (fess main)
      • opensearch Package
        • opensearch.client Package
        • opensearch.query Package
      • helper Package
      • job Package
      • entity Package
      • mylasta Package
        • mylasta.action Package
        • mylasta.direction Package
    • Design Patterns and Implementation Patterns
      • MVC Pattern
      • DI Pattern
      • Factory Pattern
      • Strategy Pattern
    • Configuration Management
      • fess_config.properties
      • fess_config.xml
      • fess_message_*.properties
    • Data Flow
      • Search Flow
      • Crawl Flow
    • Extension Points
      • Adding Custom Crawlers
      • Adding Custom Transformers
      • Adding Custom Extractors
      • Adding Custom Plugins
    • References
      • Frameworks
      • Technical Documentation
    • Next Steps
  • Development Workflow
    • Basic Development Flow
    • Step 1: Check/Create Issue
      • Checking Existing Issues
      • Creating a New Issue
        • Issue Examples
    • Step 2: Create Branch
      • Branch Naming Convention
      • Branch Creation Steps
    • Step 3: Coding
      • Coding Conventions
        • Basic Style
        • Naming Conventions
        • Comments
        • Handling null
        • Exception Handling
        • Logging
      • Testing During Development
        • Local Execution
        • Debug Execution
        • Running Unit Tests
    • Step 4: Run Local Tests
      • Running Unit Tests
      • Running Integration Tests
      • Code Format Checks
      • Running All Checks
    • Step 5: Commit
      • Commit Message Convention
      • Commit Steps
      • Commit Granularity
    • Step 6: Push
    • Step 7: Create Pull Request
      • PR Creation Steps
      • PR Example Format
      • PR Description
    • Step 8: Code Review
      • Review Aspects
      • Review Comment Examples
    • Step 9: Address Review Feedback
      • Feedback Response Steps
      • Replying to Comments
    • Step 10: Merge
      • Post-Merge Actions
    • Common Development Scenarios
      • Adding Features
      • Bug Fixes
      • Refactoring
      • Documentation Updates
    • Development Tips
      • Efficient Development
      • Problem Solving
    • Next Steps
    • References
  • Build and Test
    • Build System Overview
      • pom.xml
    • Basic Build Commands
      • Clean Build
      • Creating Packages
      • Full Build
      • Downloading Dependencies
      • Downloading OpenSearch Plugins
    • Testing
      • Running Unit Tests
        • Running All Unit Tests
        • Running Specific Test Classes
        • Running Specific Test Methods
        • Running Multiple Test Classes
      • Skipping Tests
      • Running Integration Tests
    • Writing Tests
      • Creating Unit Tests
        • Test Class Placement
        • Basic Test Class Structure
        • Test Lifecycle
        • Assertions
      • Test Coverage
    • Code Formatting
      • Code Formatter
      • License Headers
      • Pre-commit Checks
    • Creating Distribution Packages
      • Creating zip Packages
      • Creating RPM Packages
      • Creating DEB Packages
    • Profiles
      • build (default)
      • integrationTests
    • CI/CD
      • GitHub Actions
      • Local CI Checks
    • Troubleshooting
      • Build Errors
      • Test Errors
      • Dependency Issues
    • Build Best Practices
      • Regular Clean Builds
      • Running Tests
      • Running Code Formatting
      • Updating Dependencies
      • Leveraging Build Cache
    • Maven Command Reference
      • Frequently Used Commands
    • Next Steps
    • References
  • Contribution Guide
    • Introduction
    • Ways to Contribute
      • Code Contributions
      • Documentation Contributions
      • Reporting Issues
      • Community Activities
    • First Contribution
      • Step 1: Understand the Project
      • Step 2: Find an Issue
      • Step 3: Set Up Development Environment
      • Step 4: Create a Branch and Work
      • Step 5: Create Pull Request
    • Coding Conventions
      • Java Coding Style
        • Basic Style
        • Naming Conventions
        • Comments
        • Class and Method Design
        • Exception Handling
        • Handling null
        • Writing Tests
    • Code Review Guidelines
      • Pull Request Review Process
      • Review Criteria
      • Responding to Review Comments
    • Pull Request Best Practices
      • PR Size
      • PR Title
      • PR Description
      • Commit Messages
      • Using Draft PRs
    • Community Guidelines
      • Code of Conduct
      • Communication
      • Expressing Gratitude
    • Frequently Asked Questions
      • Q: Can beginners contribute?
      • Q: How long does it take for pull requests to be reviewed?
      • Q: What if my pull request is rejected?
      • Q: What if I violate coding conventions?
      • Q: What if I want to add a large feature?
      • Q: Can I ask questions in Japanese?
    • Type-Specific Contribution Guides
      • Documentation Improvements
      • Bug Reports
      • Feature Requests
      • Code Reviews
    • License
    • Acknowledgments
    • Next Steps
    • References
    • Community Resources

GitHub

Docker

JavaDoc

XRef

I/F Doc

Roadmap

• Versioning Policy
• 15.0

Changes

Issue Tracking