Welcome to eTapQuiz, an online quiz application where users can create quizzes, set start times, and challenge others to participate in live quizzes. This README provides an overview of the project, its features, and instructions for setup.
- Users can create and manage quizzes.
- Set a start time for quizzes to make them live for participants.
- Participants join quizzes at the scheduled start time.
- All participants receive the same set of questions simultaneously.
- Real-time quiz experience with a countdown timer.
- Leaderboard to track and display participants' scores.
- Web Server: Any server capable of hosting websites should work. If you don't have one, you can install Nginx or Apache.
- Firebase Account:
- Ensure you have a Firebase account. If not, you can sign up for Firebase.
- Create a Firestore database for storing user data.
- Set up a Realtime Database for additional real-time functionality.
- Enable Firebase Authentication with methods such as email/password.
- Go to the Firebase Console.
- Select your project.
- Navigate to "Authentication" in the left sidebar.
- Under the "Sign-in method" tab, enable the desired authentication methods (e.g., Email/Password).
-
Clone the repository:
git clone https://github.com/ErzenXz/etapquiz.git
-
Navigate to the project directory:
cd eTapQuiz-
Update Firebase Credentials:
In order to connect your web application to Firebase services, you'll need to replace the placeholder values in the following script with your own Firebase credentials. Here's how to obtain these credentials:
- Go to the Firebase Console.
- Select your project or create a new one.
- Navigate to "Project settings" (click on the gear icon in the top left).
- Under the "General" tab, find the "Your apps" section and click on the Firebase web app icon (
</>). - Copy the configuration object (
apiKey,authDomain,databaseURL,projectId,storageBucket,messagingSenderId,appId,measurementId).
Now, replace the placeholder values in your HTML script with the corresponding values from your Firebase project:
<script> const firebaseConfig = { apiKey: "YOUR_API_KEY", authDomain: "YOUR_AUTH_DOMAIN", databaseURL: "YOUR_DATABASE_URL", projectId: "YOUR_PROJECT_ID", storageBucket: "YOUR_STORAGE_BUCKET", messagingSenderId: "YOUR_MESSAGING_SENDER_ID", appId: "YOUR_APP_ID", measurementId: "YOUR_MEASUREMENT_ID", }; firebase.initializeApp(firebaseConfig); </script> ```
Ensure to replace each placeholder (YOUR_API_KEY, YOUR_AUTH_DOMAIN, etc.) with the corresponding values copied from your Firebase project settings.
- Start the application:
You need to have a web server, if your testing this use Live Server from VSCode
The application should be accessible at http://localhost:5500. You need to check the port your server is running because it may be different from this.
- Log in or create a new account.
- Navigate to the "Create Quiz" section.
- Fill in the details, set the start time, and add questions.
- Save the quiz.
- Log in or create a new account.
- Browse the available quizzes.
- Enroll in a quiz before the scheduled start time by just clicking on it.
- Wait until it says Started then join!
- Participants experience the quiz in real-time.
- Questions are presented simultaneously to all participants.
- Countdown timer ensures a time-limited challenge.
- Participants submit their answers within the given time.
- The leaderboard displays participants' scores in real-time.
- Updated dynamically as participants submit answers.
Contributions are welcome! Please follow the contribution guidelines.
This project is licensed under the GNU Affero General Public License v3.0.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent