rishipal commited on
Commit
1d49966
Β·
verified Β·
1 Parent(s): 46a5d60

Update Readme.md

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