HireBot AI - Candidate Assessment System

HireBot AI is a web application designed to help employers evaluate candidates' skills and knowledge through online tests. The application is built with Next.js, React, and uses Mock Service Worker (MSW) to simulate APIs during development.

System Requirements

• Node.js (version 16.x or higher)
• npm (version 8.x or higher)
• Docker (optional, for containerized deployment)

Installation

1. Clone the repository from GitHub:

   git clone <repository-url>
   cd hirebot-ai-app

2. Install dependencies:

   npm install

3. Initialize Mock Service Worker:

   npx msw init public

4. Run the application in development mode:

   npm run dev

5. Access the application at: http://localhost:3000

Project Structure

hirebot-ai-app/
├── public/                  # Static resources
│   └── mockServiceWorker.js # Service Worker for MSW
├── src/
│   ├── components/          # React components
│   ├── mock/                # API mocking with MSW
│   │   ├── data/            # Sample data
│   │   ├── browser.ts       # MSW browser configuration
│   │   └── handlers.ts      # API endpoint definitions
│   ├── pages/               # Application pages (Pages Router)
│   │   ├── admin/           # Admin pages
│   │   ├── quiz/            # Quiz pages
│   │   └── index.tsx        # Home page
│   ├── styles/              # CSS and styles
│   └── utils/               # Utility functions
├── Dockerfile               # Docker configuration
├── docker-compose.yml       # Docker Compose configuration
├── ecosystem.config.js      # PM2 configuration
├── package.json
└── next.config.js

Key Features

1. For Candidates

• Home Page: Candidates enter personal information and session code to start the test.
• Quiz Page: Displays multiple-choice questions and allows candidates to answer within the time limit.
• Results Page: Shows scores and evaluation after completing the test.

2. For Administrators

• Login: Administrators log in to the system.
• Candidate Management: View list, details, and results of candidates.
• Question Management: Add, edit, delete multiple-choice questions.
• Session Creation: Create new test sessions with parameters such as language, level, number of questions, and time limit.

User Guide

For Candidates

1. Access the home page at http://localhost:3000
2. Enter your name, email, and session code (provided by the employer)
3. Click "Start Test" to enter the quiz page
4. Answer the questions within the time limit
5. Click "Submit" when finished
6. View your results and evaluation

For Administrators

1. Access the login page at http://localhost:3000/admin/login
2. Log in with the following credentials:
   • Username: admin
   • Password: password
3. After logging in, you can:
   • View the list of candidates and their results
   • Manage multiple-choice questions
   • Create new test sessions and share session codes with candidates

API Endpoints (Mock)

The application uses Mock Service Worker to simulate the following API endpoints:

Authentication

• POST /api/login: Administrator login

Candidates

• GET /api/candidates: Get list of candidates (supports filtering and pagination)
• GET /api/candidates/:id: Get candidate details
• GET /api/candidates/:id/results: Get candidate test results

Questions

• GET /api/questions: Get list of questions (supports filtering and pagination)
• POST /api/questions: Create new question
• PUT /api/questions/:id: Update question
• DELETE /api/questions/:id: Delete question

Test Sessions

• POST /api/sessions: Create new test session
• GET /api/sessions/:token: Get session information by token
• GET /api/sessions/:token/questions: Get list of questions for the session
• POST /api/sessions/:token/submit: Submit test

Development Commands

Development Server

npm run dev

Linting and Formatting

# Run ESLint to check for issues
npm run lint

# Run ESLint with auto-fix
npm run lint:fix

# Format code with Prettier
npm run format

Build and Production

# Build the application
npm run build

# Start the production server
npm run start

Docker Deployment

1. Build and start the application:

   docker-compose up -d

2. Stop the application:

   docker-compose down

3. View logs:

   docker-compose logs -f

PM2 Deployment (without Docker)

1. Install PM2 globally:

   npm install -g pm2

2. Start the application:

   pm2 start ecosystem.config.js

3. View logs:

   pm2 logs hirebot-ai-app

4. Monitor the application:

   pm2 monit

Technologies Used

• Next.js: React framework for web application development
• React: JavaScript library for building user interfaces
• TypeScript: JavaScript extension with static typing
• Tailwind CSS: Utility-first CSS framework
• Mock Service Worker (MSW): API mocking library for development and testing
• Docker: Containerization platform for consistent deployment
• PM2: Process manager for Node.js applications in production

Notes

• This is a development version using sample data and mock APIs.
• In a production environment, you should replace MSW with actual APIs.
• Security features such as JWT authentication, password encryption, and CSRF protection should be fully implemented before actual use.
• The Docker and PM2 configurations are optimized for production deployment.

Support

If you encounter any issues or have questions, please create an issue on the GitHub repository or contact the development team.