Skip to content

Commit 0497384

Browse files
UPDATE readme
1 parent d156086 commit 0497384

15 files changed

Lines changed: 38 additions & 7 deletions

File tree

.github/workflows/ci.yml

Whitespace-only changes.

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
# Biggan Pathshala
2-
3-
---
4-
# Team CodeSynthesis
1+
# Team DU_CodeSynthesis
52

63
## Team Members
74

85
- **Mohammad Ismail Hossain**
96
- **Nandan Bhowmick**
107
- **Md. Mahfuz Ibne Ali Ayon**
118

9+
<!-- Badges -->
10+
<p align="center">
11+
<a href="https://github.com/CodeWithIsmail/BigganPathshala/graphs/contributors"><img src="https://img.shields.io/github/contributors/CodeWithIsmail/BigganPathshala" alt="Contributors"></a>
12+
<a href="#localization"><img src="https://img.shields.io/badge/lang-bn--BD%20%7C%20en--US-blue" alt="Localization"></a>
13+
</p>
14+
1215
[GitHub Repository](https://github.com/CodeWithIsmail/BigganPathshala)
1316

1417
---
@@ -29,6 +32,7 @@
2932

3033
---
3134

35+
3236
## ✨ Project Overview
3337

3438
**Biggan Pathshala** is a modern, interactive, and fully localized science tutorial, blog, and quiz platform. Students can learn science in simple language, ask questions, and create or share their own content. The platform blends the interactivity of social media with the depth of a knowledge-sharing hub.
@@ -109,6 +113,13 @@ Many students in Bangladesh and beyond struggle to connect with science due to a
109113
- **AI Integration:** Gemini API (Auto-answer, Summarization)
110114
- **Deployment:** Vercel
111115

116+
## 🛠️ Tech Stack
117+
118+
| Frontend | Backend | AI | Deployment |
119+
| ------------------------------------- | -------------------------- | ---------- | ---------- |
120+
| React.js (Vite, Tiptap, Tailwind CSS) | Firebase (Auth, Firestore) | Gemini API | Vercel |
121+
122+
---
112123

113124
## 🧩 Development Strategy
114125

@@ -136,6 +147,13 @@ npm run dev
136147

137148
---
138149

150+
## 📸 Screenshots
151+
152+
See [`screenshots.md`](screenshots.md) for visuals of the platform.
153+
154+
---
155+
156+
139157
## 🛣️ Future Roadmap
140158

141159
- Enhanced profile pictures and bios
@@ -147,4 +165,4 @@ npm run dev
147165
- Community moderation and safety
148166
- Notification system
149167

150-
---
168+
---

frontend/src/pages/LoginPage.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export default function LoginPage() {
2626
className="w-full max-w-md bg-white/90 rounded-2xl shadow-2xl p-8 flex flex-col gap-6 border border-blue-100"
2727
>
2828
<h2 className="text-3xl font-extrabold text-center bg-gradient-to-r from-blue-500 to-green-400 bg-clip-text text-transparent mb-4">
29-
Science Hub Login
29+
BigganPathshala Login
3030
</h2>
3131
<input
3232
type="email"

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

screenshots.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Screenshots
2+
3+
Below are some screenshots of Biggan Pathshala in action:
4+
5+
---
6+
7+
![Landing Page](frontend/public/science-illustration.svg)
8+
9+
_Landing page illustration_
10+
11+
---
12+
13+
<!-- Add more screenshots or GIFs here as your project evolves -->

ss/blog.png

302 KB
Loading

ss/blogAdd.png

312 KB
Loading

ss/landingPage.png

303 KB
Loading

ss/profile.png

243 KB
Loading

ss/qna.png

195 KB
Loading

0 commit comments

Comments
 (0)