Skip to content

Setup.md

Latest commit

 

History

History
192 lines (181 loc) · 6.91 KB

Setup.md

File metadata and controls

192 lines (181 loc) · 6.91 KB

📚 Examify Setup Guide

This guide will help you set up the Examify project on your local machine. Follow the steps below to get started with this online examination and classroom management system.

📋 Prerequisites

  • PHP: Ensure you have PHP installed on your machine. You can download it from here.
  • Composer: A dependency manager for PHP. You can download it from here.
  • MySQL: A relational database management system. You can download it from here.
  • Web Server: XAMPP or WAMP for running the project locally. You can download XAMPP from here or WAMP from here.
  • Git: A version control system. You can download it from here.

🚀 Installation Steps

  1. Clone the Repository: 
    git clone https://github.com/himanshsharmaa/Examify.git
cd Examify
  2. Install Dependencies: 
    composer install
  3. Configure the Database:
    • Create a new MySQL database.
    • Import the seed.sql file located in the database/ directory to set up the initial database structure and data.
    • Update the database configuration in config/db_config.php with your database credentials.
  4. Set Up Environment Variables:
    • Rename the env.php.example file in the config/ directory to env.php.
    • Update the environment variables in env.php with your configuration settings.
  5. Run the Project:
    • Start your web server (e.g., XAMPP, WAMP).
    • Place the project directory (Examify) in the web server's root directory (e.g., C:\xampp\htdocs\ for XAMPP).
    • Access the project in your web browser at http://localhost/Examify/.

📂 Project Structure

Examify/
│   .htaccess
│
├───assets
│   ├───css
│   ├───fonts
│   │       Roboto-Bold.tff      
│   │       Roboto-Regular.tff   
│   │       
│   ├───img
│   │   │   home.png
│   │   │   
│   │   ├───banners
│   │   └───icons
│   │           settings_icon.png
│   │           user_icon.png
│   │
│   └───js
│
├───config
│       constants.php
│       cors.php
│       env.php
│       functions.php
│       routes.php
│
├───database
│       db_config.php
│       migrate.php
│       seed.sql
│
├───docs
│       API.md
│       DB_STRUCTURE.md
│       LICENSE
│       README.md
│       SETUP.md
│
├───logs
│       access.log
│       error.log
│       websocket.log
│
├───public
│   │   404.php
│   │   class.php
│   │   create_class.php
│   │   index.php
│   │   join_class.php
│   │   login.php
│   │   manage_class.php
│   │   manage_test.php
│   │   result.php
│   │   select_role.php
│   │   signup.php
│   │   student_dashboard.php
│   │   student_profile.php
│   │   take_test.php
│   │   teacher_dashboard.php
│   │   teacher_profile.php
│   │   test.php
│   │   view_test_history.php
│   │
│   └───includes
│           footer.php
│           header.php
│
├───src
│   │   api.php
│   │   ws_server.php
│   │
│   └───controllers
│           auth.php
│           create_class.php
│           create_test.php
│           dashboard.php
│           get_results.php
│           join_class.php
│           login.php
│           logout.php
│           manage_class.php
│           profile.php
│           realtime_updates.php
│           register.php
│           submit_test.php
│
├───tests
│       auth_test.php
│       class_test.php
│       realtime_test.php
│       test_submission_test.php
│       utils_test.php
│
└───uploads
    ├───profile_pics
    │       student1.jpg
    │       student2.jpg
    │       teacher1.jpg
    │
    ├───reports
    │       report1.pdf
    │       report2.pdf
    │       report3.pdf
    │
    └───test_files
            answer_key.txt
            test1.pdf
            test2.docx

📁 File Descriptions

  • assets/: Contains CSS, fonts, images, and JavaScript files.
  • config/: Configuration files for constants, CORS, environment variables, functions, and routes.
  • database/: Database configuration, migration, and seed files.
  • docs/: Documentation files including API, database structure, license, and setup instructions.
  • logs/: Log files for access, errors, and websocket activities.
  • public/: Publicly accessible files including PHP scripts for various functionalities and includes for header and footer.
  • src/: Source files including API, websocket server, and controllers for various functionalities.
  • tests/: Test files for authentication, class management, real-time updates, test submission, and utility functions.
  • uploads/: Uploaded files including profile pictures, reports, and test files.

🔮 Future Enhancements

  • Real-time Notifications: Implement real-time notifications for exam updates and results.
  • Advanced Analytics: Provide detailed analytics and reports for teachers and administrators.
  • Mobile App: Develop a mobile application for easier access and management.
  • Multi-language Support: Add support for multiple languages to cater to a diverse user base.
  • Integration with LMS: Integrate with popular Learning Management Systems (LMS) for seamless data exchange.

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request.

📬 Contact

Feel free to reach out via Email.