Skip to content

Comprehensive exam prep platform by TheKhanSoft, featuring AI tools for question management, exam creation, and performance analysis. πŸš€πŸ“š

License

Notifications You must be signed in to change notification settings

arifarslan34/tks-prepify

Repository files navigation

TKS Prepify - Your Ultimate Exam Preparation Platform

TKS Prepify

πŸ“‹ Table of Contents


πŸ“ Introduction

TKS Prepify is a web application designed to help individuals prepare for various exams. The platform offers a suite of tools for both administrators and exam takers. Users can manage questions, create exams, receive AI-powered feedback, and analyze performance. This application aims to enhance the exam preparation experience with a modern, responsive interface.

πŸš€ Features

  • Question Management: Easily add, edit, or delete questions.
  • Exam Creation: Create custom exams tailored to specific needs.
  • AI-Powered Feedback: Get instant feedback on performance.
  • Performance Analysis: Track progress over time with detailed analytics.
  • User-Friendly Interface: Navigate the platform with ease.
  • Responsive Design: Access the platform on any device.
  • Adaptive Learning: Personalize the learning experience based on user performance.

βš™οΈ Technologies Used

  • Frontend: React, ReactJS
  • Backend: Node.js
  • Database: Firebase
  • Hosting: Firebase Hosting
  • Other Tools: Various libraries and frameworks for enhanced functionality

πŸ› οΈ Installation

To install TKS Prepify, follow these steps:

  1. Clone the repository:
    git clone https://github.com/arifarslan34/tks-prepify.git
  2. Navigate to the project directory:
    cd tks-prepify
  3. Install the required packages:
    npm install
  4. Set up your Firebase project and configure the environment variables.
  5. Start the development server:
    npm start

πŸ–₯️ Usage

After installation, you can start using TKS Prepify. Follow these steps:

  1. Open your web browser and go to http://localhost:3000.
  2. Create an account or log in if you already have one.
  3. Navigate to the dashboard to access various features like exam creation and performance analysis.
  4. Use the question management tool to add or edit questions.
  5. Create an exam and invite users to participate.

βš™οΈ Configuration

To configure TKS Prepify, you need to set up your Firebase project:

  1. Go to the Firebase Console.
  2. Create a new project or select an existing one.
  3. Add a web app to your project and copy the configuration details.
  4. Create a .env file in the root directory of your project and add the following:
    REACT_APP_FIREBASE_API_KEY=your_api_key
    REACT_APP_FIREBASE_AUTH_DOMAIN=your_auth_domain
    REACT_APP_FIREBASE_DATABASE_URL=your_database_url
    REACT_APP_FIREBASE_PROJECT_ID=your_project_id
    REACT_APP_FIREBASE_STORAGE_BUCKET=your_storage_bucket
    REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
    REACT_APP_FIREBASE_APP_ID=your_app_id

πŸ§ͺ Testing

To run tests for TKS Prepify, use the following command:

npm test

This will execute the test suite and provide feedback on the code quality and functionality.

🀝 Contributing

Contributions are welcome! To contribute to TKS Prepify, follow these steps:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:
    git commit -m "Add your message"
  4. Push to your branch:
    git push origin feature/your-feature-name
  5. Create a pull request.

πŸ“œ Code of Conduct

We expect all contributors to adhere to our code of conduct. Please be respectful and inclusive. Any form of harassment or discrimination will not be tolerated.

πŸ”’ Security Vulnerabilities

If you discover a security vulnerability, please report it to us by creating an issue in the repository. We take security seriously and will address any vulnerabilities promptly.

πŸ“„ License

This project is licensed under the MIT License. See the LICENSE file for details.

πŸ“ž Contact

For any inquiries or support, please reach out to us at:

For the latest updates, please visit the Releases section. You can download the latest version and execute it to start using TKS Prepify.


Topics: adaptive-learning, education, exam-management, exam-management-system, exam-preparation, firebase, node, node-js, online-exams, react, reactjs

About

Comprehensive exam prep platform by TheKhanSoft, featuring AI tools for question management, exam creation, and performance analysis. πŸš€πŸ“š

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages