- Introduction
- Features
- Technologies Used
- Installation
- Usage
- Configuration
- Testing
- Contributing
- Code of Conduct
- Security Vulnerabilities
- License
- Contact
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.
- 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.
- Frontend: React, ReactJS
- Backend: Node.js
- Database: Firebase
- Hosting: Firebase Hosting
- Other Tools: Various libraries and frameworks for enhanced functionality
To install TKS Prepify, follow these steps:
- Clone the repository:
git clone https://github.com/arifarslan34/tks-prepify.git
- Navigate to the project directory:
cd tks-prepify - Install the required packages:
npm install
- Set up your Firebase project and configure the environment variables.
- Start the development server:
npm start
After installation, you can start using TKS Prepify. Follow these steps:
- Open your web browser and go to
http://localhost:3000. - Create an account or log in if you already have one.
- Navigate to the dashboard to access various features like exam creation and performance analysis.
- Use the question management tool to add or edit questions.
- Create an exam and invite users to participate.
To configure TKS Prepify, you need to set up your Firebase project:
- Go to the Firebase Console.
- Create a new project or select an existing one.
- Add a web app to your project and copy the configuration details.
- Create a
.envfile 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
To run tests for TKS Prepify, use the following command:
npm testThis will execute the test suite and provide feedback on the code quality and functionality.
Contributions are welcome! To contribute to TKS Prepify, follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m "Add your message" - Push to your branch:
git push origin feature/your-feature-name
- Create a pull request.
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.
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.
This project is licensed under the MIT License. See the LICENSE file for details.
For any inquiries or support, please reach out to us at:
- Email: support@thekhansoft.com
- GitHub: TKS Prepify Issues
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