User Manual - CankayaUniversity/ceng-407-408-2024-2025-Job-Application-and-Matching-Platform GitHub Wiki
Table of Contents
- 1. Introduction
- 2. System Requirements
- 3. Installation and Setup
- 4. User Interface Guide
- 5. Job Seeker Module
- 6. Employer Module
- 7. AI Job Matching System
- 8. Data Privacy and Security
- 9. Troubleshooting and FAQs
1. Introduction
Purpose and Scope:
This manual guides users on how to efficiently use the AI-Powered Job Matching Platform, covering installation, usage, and troubleshooting for both job seekers and employers.
Intended Audience:
Job seekers, employers, and administrators who will utilize the platform.
Structure of the Manual:
Follows the user's journey from installation to advanced usage.
2. System Requirements
Hardware Requirements:
- Processor: Minimum Intel Core i3 or equivalent
- Memory: 4 GB RAM (8 GB recommended)
- Storage: 2 GB free disk space
- Graphics: Integrated graphics card
Software Requirements:
- Operating System: Windows 10+, Ubuntu 20.04+
- Web Browser: Chrome, Firefox, Edge, Safari
- Database: PostgreSQL
Network Requirements:
- Stable internet connection (at least 5 Mbps)
- HTTPS enabled for secure data transmission
3. Installation and Setup
Step-by-Step Installation Instructions:
- Download the setup file from the GitHub Releases Page.
- Run the installer and follow the prompts.
- Set up the PostgreSQL database connection.
- Complete the initial configuration settings.
- Launch the application.
Configuration Settings:
- Database URL: Enter the PostgreSQL connection string.
- API Key Configuration: Set up API keys for ElasticSearch and notification services.
Initial User Registration:
- Access the registration page.
- Provide a valid email address and password.
- Verify the email via the link sent to your inbox.
- Complete the profile setup.
Running the Project
After completing the installation and initial setup, you can start both the backend and frontend servers as follows:
Backend (Spring Boot)
# Navigate to the backend folder
cd Backend
# Run the Spring Boot application
./mvnw spring-boot:run
Requires Java JDK 17+ and Maven installed.
Frontend (React)
# Navigate to the frontend folder
cd Frontend
# Install Node.js dependencies
npm install
# Start the development server
npm run dev
Requires Node.js and npm installed.
4. User Interface Guide
Main Dashboard Overview:
- Displays recent job matches, notifications, and quick links.
- Customizable widgets for quick access to essential features.
Navigation Menu:
- Job Seeker Menu: Profile, Job Search, Messages, Saved Jobs
- Employer Menu: Post Job, Candidate Search, Manage Applications
Profile Management:
- Edit profile details such as education, skills, and experience.
- Upload or update the resume.
- Delete or freeze the account.
Notifications and Messaging:
- Real-time chat with employers or job seekers.
- System notifications for application updates and interview schedules.
5. Job Seeker Module
Registering and Logging In:
- Access the login page and enter credentials.
- Use 'Forgot Password' if needed.
Creating and Updating Profile:
- Add professional details, skills, and preferred job types.
Searching for Jobs:
- Use filters like job title, location, and salary.
- Advanced Search: Utilize AI-powered suggestions for better matches.
Applying to Job Postings:
- Click 'Apply' and upload a tailored CV.
- Save job listings for future reference.
Messaging Employers and Scheduling Interviews:
- Access messaging via the dashboard.
- Set appointment times and receive confirmation.
Saving and Tracking Job Applications:
- Save jobs for later and view ongoing application statuses.
- Receive notifications when an employer reviews your application.
Setting Job Preferences:
- Customize job alerts by industry, salary, and location.
Common Job Seeker Issues and Solutions:
Issue | Cause | Solution |
---|---|---|
Unable to Login | Incorrect password | Reset password using 'Forgot Password' |
Application Not Submitting | Missing required fields | Complete all mandatory fields |
No Job Matches Found | Insufficient profile details | Update profile with complete skills |
6. Employer Module
Creating Job Advertisements:
- Fill in job title, description, and required skills.
- Set application deadlines and visibility settings.
- Use templates to streamline postings.
Managing Job Listings:
- Edit or remove job advertisements.
- Archive old listings while keeping data intact.
Searching Candidate Profiles:
- Use keyword and skill filters.
- Access candidate portfolios from search results.
Reviewing and Managing Applications:
- Shortlist candidates and add internal comments.
- Download CVs and other supporting documents.
Scheduling Interviews and Sending Offers:
- Use integrated calendar to set interview dates.
- Send automated offer letters from the system.
Employer Troubleshooting Guide:
Problem | Cause | Solution |
---|---|---|
Candidates Not Appearing | Search filters too restrictive | Broaden search criteria |
Unable to Edit Job Listing | Advertisement already published | Unpublish the job to edit |
Interview Scheduling Issues | Calendar not syncing | Refresh the page and check settings |
7. AI Job Matching System
How AI Matching Works:
- Analyzes profiles and job requirements.
- Factors: Skills, experience, job preferences, profile completeness.
Reviewing Job Suggestions:
- Jobs ranked by relevance and compatibility.
- View detailed job analytics, including matching scores.
Candidate Recommendations for Employers:
- AI suggests candidates best fitting the job description.
- View candidate matching scores.
Feedback and AI Improvement:
- Users can rate the relevance of matches to improve the system.
AI Performance and Accuracy Metrics:
Metric | Target Accuracy | Current Accuracy |
---|---|---|
Job Match Accuracy | 85% | 82% |
Candidate Fit Accuracy | 90% | 87% |
8. Data Privacy and Security
Compliance with GDPR and KVKK:
- Ensures data protection and user consent management.
Data Encryption and Protection:
- Uses HTTPS for secure data transmission.
Backup and Recovery:
- Daily automatic backups stored securely.
- Data recovery procedures for accidental deletions.
9. Troubleshooting and FAQs
- Login Issues: Reset password or contact support.
- Messaging Problems: Check network connection and app version.
- Profile Update Errors: Ensure all required fields are filled.
- AI Matching Errors: Update profile with relevant skills.
- Job Application Issues: Clear browser cache and retry.