https://github.com/mehedi752/lingo-bingo-website
Welcome to the Vocabulary Learning Website, an interactive platform designed to help users enhance their vocabulary through flashcards, quizzes, and real-time progress tracking. Built with ReactJS and Firebase, this application ensures a seamless and engaging learning experience
https://github.com/mehedi752/lingo-bingo-website
firebase html5 javascript react tailwind-css
Last synced: 3 months ago
JSON representation
Welcome to the Vocabulary Learning Website, an interactive platform designed to help users enhance their vocabulary through flashcards, quizzes, and real-time progress tracking. Built with ReactJS and Firebase, this application ensures a seamless and engaging learning experience
- Host: GitHub
- URL: https://github.com/mehedi752/lingo-bingo-website
- Owner: Mehedi752
- Created: 2025-01-13T02:38:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-04T19:25:20.000Z (over 1 year ago)
- Last Synced: 2025-02-04T20:28:43.217Z (over 1 year ago)
- Topics: firebase, html5, javascript, react, tailwind-css
- Language: JavaScript
- Homepage: https://your-live-project-url.web.app
- Size: 1.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# π‘ Vocabulary Learning Website
Welcome to the **Vocabulary Learning Website**, an interactive platform designed to help users enhance their vocabulary through flashcards, quizzes, and real-time progress tracking. Built with **ReactJS** and **Firebase**, this application ensures a seamless and engaging learning experienceπ
---
## **β¨ Core Features**
### **π User Authentication**
- Secure login and signup using **Firebase Authentication**.
- Supports Google Sign-In for quick access.
### **π Vocabulary Flashcards**
- Users can create, edit, and delete flashcards.
- Organize words into different categories.
### **π Progress Tracking**
- Tracks user learning progress in real-time.
- Displays quiz scores and completed flashcards.
### **π‘ Real-Time Database**
- Uses **Firebase Firestore** to store and sync data instantly.
- Ensures fast and efficient retrieval of vocabulary lists.
### **π¨ Smooth User Experience**
- Built with **ReactJS**, ensuring seamless interactions without page reloads.
- **React Router** enables smooth navigation.
### **π± Fully Responsive Design**
- Optimized for **desktop, tablet, and mobile** users.
---
## **π Live Demo**
[π Vocabulary Learning Website - Live Version](https://your-live-project-url.web.app)
---
## **π Tech Stack**
### **Frontend:**
- React.js
- Tailwind CSS
- Daisy UI
- React Router
- React Toastify (Notifications)
### **Backend (Firebase Services):**
- Firebase Authentication (User Login & Signup)
- Firebase Firestore (Real-time Database)
### **Additional Tools:**
- Axios for API requests
- Sweet Alert for user-friendly popups
---
## **π¦ Dependencies**
### **Frontend Dependencies (`package.json`)**
- `react`
- `react-router-dom`
- `tailwindcss`
- `daisyui`
- `react-toastify`
- `firebase`
- `react-icons`
---
## **π» Installation & Setup**
Follow these steps to set up **Vocabulary Learning Website** on your local machine.
### **1οΈβ£ Clone the Repository**
```bash
git clone https://github.com/your-username/vocabulary-learning.git
cd vocabulary-learning
```
### **2οΈβ£ Install Dependencies**
```bash
npm install # Install required npm packages
```
### **3οΈβ£ Configure Firebase**
1. Go to [Firebase Console](https://console.firebase.google.com/)
2. Create a new Firebase project.
3. Enable **Authentication** (Google Sign-In and Email/Password Login).
4. Enable **Firestore Database** and set up security rules.
5. Copy your Firebase configuration details and add them to a `.env` file.
### **4οΈβ£ Set Up Environment Variables**
Create a `.env` file inside your project and add:
```env
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_AUTH_DOMAIN=your_firebase_auth_domain
VITE_PROJECT_ID=your_firebase_project_id
VITE_STORAGE_BUCKET=your_firebase_storage_bucket
VITE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
VITE_APP_ID=your_firebase_app_id
```
### **5οΈβ£ Start the Development Server**
```bash
npm run dev # Runs the React frontend
```
Now, open **http://localhost:5173/** in your browser to start learning new words! π
---
## **π οΈ Contributing**
We welcome contributions! Follow these steps to contribute:
1. **Fork** the repository.
2. **Create a feature branch** (`git checkout -b feature-name`).
3. **Commit your changes** (`git commit -m "Added new feature"`).
4. **Push to your branch** (`git push origin feature-name`).
5. **Create a Pull Request**.
---
## **π License**
This project is **open-source** and licensed under the **MIT License**.
---