Spaces:
Configuration error
Configuration error
folder upload
#1
by
rishipal
- opened
- Readme.md +109 -124
- contributing.md +18 -18
Readme.md
CHANGED
|
@@ -1,124 +1,109 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
---
|
| 16 |
-
|
| 17 |
-
##
|
| 18 |
-
|
| 19 |
-
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
-
|
| 34 |
-
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
|
| 110 |
-
βββ README.md # Project overview and setup
|
| 111 |
-
βββ story_engine/ # All logic modules for fetching and generating story content
|
| 112 |
-
β βββ __init__.py
|
| 113 |
-
β βββ wikipedia.py
|
| 114 |
-
β βββ wikiquote.py
|
| 115 |
-
β βββ wikisource.py
|
| 116 |
-
β βββ commons.py
|
| 117 |
-
β βββ wikidata.py
|
| 118 |
-
β βββ wikibooks.py
|
| 119 |
-
β βββ formatter.py
|
| 120 |
-
β βββ story_builder.py # Core function to build story from APIs
|
| 121 |
-
|
| 122 |
-
```
|
| 123 |
-
|
| 124 |
-
> π `story_engine/` contains modular Python files to keep the logic clean and testable.
|
|
|
|
| 1 |
+
# π WikiSage β All Wiki Resources for a Topic
|
| 2 |
+
|
| 3 |
+
> π One Topic. All Wiki. Your Way.
|
| 4 |
+
|
| 5 |
+
## Team Members
|
| 6 |
+
- Rishi Palavarapu
|
| 7 |
+
- Harsha Ambati
|
| 8 |
+
- Rishitha Reddy
|
| 9 |
+
- Yaswanth Ambati
|
| 10 |
+
|
| 11 |
+
## π§ Overview
|
| 12 |
+
|
| 13 |
+
**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.
|
| 14 |
+
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
## π― Problem Statement
|
| 18 |
+
|
| 19 |
+
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**.
|
| 20 |
+
|
| 21 |
+
There is no unified platform that allows learners to:
|
| 22 |
+
|
| 23 |
+
- Seamlessly explore all types of Wikimedia content (articles, books, quotes, images, source texts) on **one topic**
|
| 24 |
+
- **Access diverse formats of learning content** (definitions, timelines, media, references)
|
| 25 |
+
- Interact with this knowledge in a structured, multilingual, and accessible way
|
| 26 |
+
|
| 27 |
+
---
|
| 28 |
+
|
| 29 |
+
## π‘ Solution
|
| 30 |
+
|
| 31 |
+
**WikiSage** solves this by:
|
| 32 |
+
- Fetching content from multiple Wikimedia public APIs
|
| 33 |
+
- Structuring them into an intuitive, topic-based interface
|
| 34 |
+
- Providing features like multilingual support, content export, and related topic mapping
|
| 35 |
+
|
| 36 |
+
---
|
| 37 |
+
|
| 38 |
+
## π Features
|
| 39 |
+
|
| 40 |
+
| Feature | Description |
|
| 41 |
+
|--------|-------------|
|
| 42 |
+
| π **Smart Topic Search** | User inputs a topic (e.g., "Quantum Physics", "Mahatma Gandhi") |
|
| 43 |
+
| π **Knowledge Summary** | Summary and detailed content from Wikipedia |
|
| 44 |
+
| π **In-Depth Books** | Structured reading material from Wikibooks |
|
| 45 |
+
| π¬ **Famous Quotes** | Related quotes using Wikiquote |
|
| 46 |
+
| π **Primary Sources** | Historical documents from Wikisource |
|
| 47 |
+
| πΌοΈ **Media Gallery** | Relevant images from Commons |
|
| 48 |
+
| π§ **Linked Topics Map** | Visual exploration of related topics via Wikidata |
|
| 49 |
+
| π **Multilingual Mode** | Pulls topic info in different languages via Wikimedia APIs |
|
| 50 |
+
| π₯ **Export Feature** | Download topic summary as PDF or Markdown |
|
| 51 |
+
|
| 52 |
+
---
|
| 53 |
+
|
| 54 |
+
## π APIs Used
|
| 55 |
+
|
| 56 |
+
All APIs are strictly from the list approved in the [WikiVerse Hackathon Guidelines](#):
|
| 57 |
+
|
| 58 |
+
| API | Purpose |
|
| 59 |
+
|-----|---------|
|
| 60 |
+
| Wikipedia (`en.wikipedia.org`) | Topic summaries & articles |
|
| 61 |
+
| Wikibooks (`en.wikibooks.org`) | Educational book modules |
|
| 62 |
+
| Wikisource (`en.wikisource.org`) | Primary documents |
|
| 63 |
+
| Wikiquote (`en.wikiquote.org`) | Famous quotes |
|
| 64 |
+
| Commons (`commons.wikimedia.org`) | Media assets (images, posters, etc.) |
|
| 65 |
+
| Wiktionary (`en.wiktionary.org`) | Definitions and multilingual word meanings |
|
| 66 |
+
| Wikidata (`www.wikidata.org`) | Related concepts and metadata |
|
| 67 |
+
|
| 68 |
+
---
|
| 69 |
+
|
| 70 |
+
## π― Target Users
|
| 71 |
+
|
| 72 |
+
- π Students researching a subject
|
| 73 |
+
- π§ Self-learners exploring a new topic
|
| 74 |
+
- π¨βπ« Educators curating study content
|
| 75 |
+
- π° Content creators/fact-checkers
|
| 76 |
+
- π Anyone interested in structured, verified knowledge
|
| 77 |
+
|
| 78 |
+
---
|
| 79 |
+
|
| 80 |
+
## π οΈ Tech Stack
|
| 81 |
+
|
| 82 |
+
- **Frontend**: HTML, CSS, JavaScript / React (choose based on final implementation)
|
| 83 |
+
- **Backend**: Node.js / Python (for API integration & routing)
|
| 84 |
+
- **APIs**: RESTful calls to Wikimedia APIs
|
| 85 |
+
- **Hosting**: GitLab Pages / Local, Streamlit Cloud
|
| 86 |
+
|
| 87 |
+
---
|
| 88 |
+
|
| 89 |
+
## π¦ Project Structure
|
| 90 |
+
| Hour | Phase | Tasks |
|
| 91 |
+
|------|-------------------------------|-----------------------------------------------------------------------|
|
| 92 |
+
| 1 | *Ideation & Planning* | Define app scope, identify APIs needed, finalize features, assign tasks |
|
| 93 |
+
| 2 | *UI/UX & Architecture* | Design layout, multilingual UI, API-client separation, wireframes |
|
| 94 |
+
| 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 |
|
| 95 |
+
| 6 | *Testing* | Test multilingual search, output display, and error handling |
|
| 96 |
+
| 7 | *Deployment & Refinement* | Final fixes, improve UI, connect frontend to backend APIs |
|
| 97 |
+
| 8 | *Documentation & Pitch Prep*| Finalize README, prepare 5-minute demo and presentation |
|
| 98 |
+
|
| 99 |
+
|
| 100 |
+
---
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
## π How to Run Locally
|
| 104 |
+
|
| 105 |
+
```bash
|
| 106 |
+
git clone https://gitlab.com/your-team/wiki-sage.git
|
| 107 |
+
cd wiki-sage
|
| 108 |
+
npm install
|
| 109 |
+
npm start
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
contributing.md
CHANGED
|
@@ -1,18 +1,18 @@
|
|
| 1 |
-
# π€ Contributing to WikiSage
|
| 2 |
-
|
| 3 |
-
Welcome to the WikiSage project β an open knowledge app built for the WikiVerse Hackathon.
|
| 4 |
-
Weβre glad you want to help make it better! π§
|
| 5 |
-
|
| 6 |
-
Please follow these guidelines to ensure clean, stable, and collaborative development
|
| 7 |
-
|
| 8 |
-
---
|
| 9 |
-
|
| 10 |
-
## π§ Setup Instructions
|
| 11 |
-
|
| 12 |
-
To get started:
|
| 13 |
-
|
| 14 |
-
1. **Clone the repository**:
|
| 15 |
-
|
| 16 |
-
```bash
|
| 17 |
-
git clone https://gitlab.com/your-team/wiki-sage.git
|
| 18 |
-
cd wiki-sage
|
|
|
|
| 1 |
+
# π€ Contributing to WikiSage
|
| 2 |
+
|
| 3 |
+
Welcome to the WikiSage project β an open knowledge app built for the WikiVerse Hackathon.
|
| 4 |
+
Weβre glad you want to help make it better! π§
|
| 5 |
+
|
| 6 |
+
Please follow these guidelines to ensure clean, stable, and collaborative development.
|
| 7 |
+
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
## π§ Setup Instructions
|
| 11 |
+
|
| 12 |
+
To get started:
|
| 13 |
+
|
| 14 |
+
1. **Clone the repository**:
|
| 15 |
+
|
| 16 |
+
```bash
|
| 17 |
+
git clone https://gitlab.com/your-team/wiki-sage.git
|
| 18 |
+
cd wiki-sage
|