Lucy::...torial(3pm)

📦
version 0.6.2 · 2 versions
, in fedora 43

✨ NAME ✨

okay bestie, welcome to Lucy::...torial(3pm) — this is Lucy::Docs::Tutorial, aka your step-by-step introduction to Apache Lucy. 🫶

🌸 DESCRIPTION 🌸

So here's the vibe: we're gonna explore Apache Lucy's basic functionality together, and the way we do that is we start with a minimalist CGI search app built on Lucy::Simple, and then we transform it, step by step, into an "advanced search" interface that uses the more flexible core modules like Indexer and IndexSearcher. it's giving glow-up arc, fr fr. 💅

📖 Chapters 📖

  • SimpleTutorial — build a bare-bones search app using Lucy::Simple. the starter pack, the origin story. ✨
  • BeyondSimpleTutorial — rebuild the app using core classes like Indexer and IndexSearcher in place of Lucy::Simple. glow-up part two. 👑
  • FieldTypeTutorial — experiment with different field characteristics using subclasses of FieldType. mix and match, it's fun.
  • AnalysisTutorial — examine how the choice of Analyzer subclass affects search results. the way that one tiny choice changes everything? iconic.
  • HighlighterTutorial — augment search results with highlighted excerpts. sparkle on the results, we love to see it. ✨
  • QueryObjectsTutorial — unlock advanced search features by using Query objects instead of query strings. the final boss. 🔥

🍓 Source materials 🍓

The source material used by the tutorial app — a multi-text-file presentation of the United States constitution — lives in the "sample" directory at the root of the Lucy distribution, right alongside finished indexing and search apps. no cap.

sample/indexer.pl        # indexing app
sample/search.cgi        # search app
sample/us_constitution   # corpus

🎀 Conventions 🎀

You're expected to already be familiar with OO Perl and basic CGI programming. like, that's the prerequisite bestie, i don't make the rules. 🙈

The code in this tutorial assumes a Unix-flavored operating system and the Apache webserver — but lowkey it'll work with minor modifications on other setups too. 💜

🦋 See also 🦋

More advanced and esoteric subjects are covered in Cookbook. go there when you're ready to level up. ⭐

and that's the whole page, bestie!! this was perl v5.42.0, dated 2025-07-25, and it's the Lucy::...torial(3pm) page — mwah, go build something cute 💖🧚

📦 where this page comes from