Spaces:

rishipal
/

WikiTales

Configuration error

App Files Files Community

rishipal commited on Jul 2, 2025

Commit

5e9268b

verified ·

1 Parent(s): dca465c

Update Readme.md

Browse files

Files changed (1) hide show

Readme.md +114 -109

Readme.md CHANGED Viewed

@@ -1,109 +1,114 @@
-# 📚 WikiSage – All Wiki Resources for a Topic
-> 🔍 One Topic. All Wiki. Your Way.
-## Team Members
-- Rishi Palavarapu
-- Harsha Ambati
-- Rishitha Reddy
-- Yaswanth Ambati
-## 🧠 Overview
-**WikiSage** is a smart, educational app built for the WikiVerse Hackathon. It allows users to explore **comprehensive information about any topic** by aggregating and organizing resources from across Wikimedia projects like Wikipedia, Wikibooks, Wikiquote, Commons, Wikisource, and more — all in one place.
----
-## 🎯 Problem Statement
-Millions of users rely on Wikimedia for learning, but navigating multiple platforms (Wikipedia, Wikibooks, Wikiquote, etc.) to gather full information on a single topic is **time-consuming and fragmented**.
-There is no unified platform that allows learners to:
-- Seamlessly explore all types of Wikimedia content (articles, books, quotes, images, source texts) on **one topic**
-- **Access diverse formats of learning content** (definitions, timelines, media, references)
-- Interact with this knowledge in a structured, multilingual, and accessible way
----
-## 💡 Solution
-**WikiSage** solves this by:
-- Fetching content from multiple Wikimedia public APIs
-- Structuring them into an intuitive, topic-based interface
-- Providing features like multilingual support, content export, and related topic mapping
----
-## 🚀 Features
-| Feature | Description |
-|--------|-------------|
-| 🔍 **Smart Topic Search** | User inputs a topic (e.g., "Quantum Physics", "Mahatma Gandhi") |
-| 📄 **Knowledge Summary** | Summary and detailed content from Wikipedia |
-| 📚 **In-Depth Books** | Structured reading material from Wikibooks |
-| 💬 **Famous Quotes** | Related quotes using Wikiquote |
-| 📜 **Primary Sources** | Historical documents from Wikisource |
-| 🖼️ **Media Gallery** | Relevant images from Commons |
-| 🧠 **Linked Topics Map** | Visual exploration of related topics via Wikidata |
-| 🌐 **Multilingual Mode** | Pulls topic info in different languages via Wikimedia APIs |
-| 📥 **Export Feature** | Download topic summary as PDF or Markdown |
----
-## 🌐 APIs Used
-All APIs are strictly from the list approved in the [WikiVerse Hackathon Guidelines](#):
-| API | Purpose |
-|-----|---------|
-| Wikipedia (`en.wikipedia.org`) | Topic summaries & articles |
-| Wikibooks (`en.wikibooks.org`) | Educational book modules |
-| Wikisource (`en.wikisource.org`) | Primary documents |
-| Wikiquote (`en.wikiquote.org`) | Famous quotes |
-| Commons (`commons.wikimedia.org`) | Media assets (images, posters, etc.) |
-| Wiktionary (`en.wiktionary.org`) | Definitions and multilingual word meanings |
-| Wikidata (`www.wikidata.org`) | Related concepts and metadata |
----
-## 🎯 Target Users
-- 📘 Students researching a subject
-- 🧠 Self-learners exploring a new topic
-- 👨‍🏫 Educators curating study content
-- 📰 Content creators/fact-checkers
-- 🌍 Anyone interested in structured, verified knowledge
----
-## 🛠️ Tech Stack
-- **Frontend**: HTML, CSS, JavaScript / React (choose based on final implementation)
-- **Backend**: Node.js / Python (for API integration & routing)
-- **APIs**: RESTful calls to Wikimedia APIs
-- **Hosting**: GitLab Pages / Local, Streamlit Cloud
----
-## 📦 Project Structure
-| Hour | Phase                         | Tasks                                                                 |
-|------|-------------------------------|-----------------------------------------------------------------------|
-| 1    | *Ideation & Planning*       | Define app scope, identify APIs needed, finalize features, assign tasks |
-| 2    | *UI/UX & Architecture*      | Design layout, multilingual UI, API-client separation, wireframes     |
-| 3-5  | *Development Phase*         | Build Python backend (API wrappers for Wikipedia, Commons, Wikidata) <br> Build frontend with search UI + display views <br> Integrate AI model for summarization |
-| 6    | *Testing*                   | Test multilingual search, output display, and error handling          |
-| 7    | *Deployment & Refinement*   | Final fixes, improve UI, connect frontend to backend APIs             |
-| 8    | *Documentation & Pitch Prep*| Finalize README, prepare 5-minute demo and presentation             |
----
-## 📖 How to Run Locally
-```bash
-git clone https://gitlab.com/your-team/wiki-sage.git
-cd wiki-sage
-npm install
-npm start

+# 📖 WikiTales – Interactive Historical Storybooks
+> WikiTales is an open-source, story-driven web app that transforms raw historical data from Wikimedia projects into immersive, engaging storybook-style narratives. Built with Python and Streamlit, it’s designed to help learners explore the past like never before.
+---
+## Team Members
+- Rishi Palavarapu
+- Harsha Ambati
+- Rishitha Reddy
+- Yaswanth Ambati
+---
+## 🚀 Overview
+WikiTales bridges storytelling and research by compiling content from **Wikimedia public APIs** such as Wikipedia, Wikiquote, Wikidata, Wikisource, Wikibooks, and more. It generates narrative summaries, trivia facts, quotes, timelines, and glossary definitions based on user-entered topics.
+---
+## 🔍 Key Features
+- 🧠 **AI-generated Story Narratives** based on historical events and figures
+- 🎭 **Narrator Styles**: Choose between historian, eyewitness, journalist, AI assistant, etc.
+- 🧾 **Dynamic Timelines** of important events
+- 💬 **Quotes & Primary Sources** from Wikiquote and Wikisource
+- 🧠 **“Did You Know?” Facts** from Wikidata
+- 📚 **Wikibooks Sidebar** for extended learning material
+- 📸 **Image Carousel** using Wikimedia Commons
+---
+## 🛠️ Built With
+- **Frontend & UI**: [Streamlit](https://streamlit.io/)
+- **Language**: Python 3.10+
+- **Data Sources**:
+  - [Wikipedia API](https://en.wikipedia.org/w/api.php)
+  - [Wikidata API](https://www.wikidata.org/w/api.php)
+  - [Wikibooks API](https://en.wikibooks.org/w/api.php)
+  - [Wikiquote API](https://en.wikiquote.org/w/api.php)
+  - [Wiktionary API](https://en.wiktionary.org/w/api.php)
+  - [Wikisource API](https://en.wikisource.org/w/api.php)
+  - [Wikimedia Commons API](https://commons.wikimedia.org/w/api.php)
+---
+## ⚙️ How It Works
+1. **User enters a topic** (e.g. *World War II*).
+2. WikiTales fetches:
+   - Summary from Wikipedia
+   - Quotes from Wikiquote
+   - Timeline from Wikidata
+   - Definitions from Wiktionary
+   - Images from Commons
+   - Source documents from Wikisource
+   - Related books from Wikibooks
+3. Story is narrated using the selected voice and formatted as a storybook.
+4. Additional enhancements include interactive glossary and image carousel.
+---
+## 🔧 Setup Instructions
+To get started with this project, follow these steps:
+```bash
+# Clone the repository
+git clone https://code.swecha.org/soai2025/soai-hackathon/team-titans.git
+# Navigate to the project folder
+cd team-titans
+# (Optional but recommended) Create a virtual environment
+python3 -m venv wikitales_venv
+source wikitales_venv/bin/activate
+# Install dependencies
+pip install -r requirements.txt
+# Run the app locally
+streamlit run app.py
+```
+---
+### 🚀 Deployment
+This app is designed to be deployed on [Hugging Face Spaces](https://huggingface.co/spaces) using the **Streamlit template**.
+---
+### 🗂️ Project Structure
+```
+WikiTales/
+├── app.py                      # Main Streamlit app
+├── requirements.txt            # Python dependencies
+├── README.md                   # Project overview and setup
+├── story_engine/               # All logic modules for fetching and generating story content
+│   ├── __init__.py
+│   ├── wikipedia.py
+│   ├── wikiquote.py
+│   ├── wikisource.py
+│   ├── commons.py
+│   ├── wikidata.py
+│   ├── wikibooks.py
+│   ├── formatter.py
+│   └── story_builder.py        # Core function to build story from APIs
+```
+> 📁 `story_engine/` contains modular Python files to keep the logic clean and testable.