User Starting Guide

User Starting Guide

This page serves as the central documentation hub for understanding, using, and maintaining the project. Below are the main sections that will guide both users and developers.

Table of Contents

• Introduction
• Key Features
• Installation
  • Prerequisites
  • Steps
• Usage
• Available Commands
  • Question Management
  • Exam Management
  • Contact Management

Introduction

GL02_projet_OGMen is a Command Line Interface (CLI) application designed to manage a question and exam database. Users can import questions from GIFT files, manipulate them (add, delete, search, deduplicate), and generate exams. This application is a practical tool for educators to streamline the exam preparation process.

Key Features

• Import questions from GIFT files.
• Manage questions: add, delete, search, deduplicate.
• Generate exams containing 15-20 questions.
• Export exams in GIFT format.
• View questions and exams.
• Manage contacts: create, modify, delete, search.
• Generate HTML charts to visualize question distributions.

Installation

Prerequisites

• Node.js
• npm

Steps

1. Clone the repository:

   git clone https://github.com/aminssutt/GL02_projet_OGMen.git
   cd GL02_projet_OGMen/src

2. Install dependencies:

   npm install

Usage

To launch the CLI application, run the following command:

cd src
node everywhereCli.js

Available Commands

Question Management

1. questions list - Display all questions.
2. questions import - Import questions from the ./data directory.
3. questions delete --title <title> - Delete a question by its exact title.
4. questions add --text <text> --type <type> - Add a new question.
5. questions chart - Generate an HTML file with a chart of question types.
6. questions deduplicate - Remove duplicate question titles.

Exam Management

7. exam generate - Generate an exam with 15-20 questions.
8. exam export --id <id> - Export an exam in GIFT format.
9. visualize exam - Visualize an exam as a bar chart.
10. visualizeExamTheme - Visualize an exam profile by theme as a bar chart.
11. search exam - Search for an exam by ID or date.
12. simulate exam - Simulate an exam with results.

Contact Management

13. contact create - Create a new contact.
14. contact update - Update a contact.
15. contact read - Read information about a contact.
16. contact delete - Delete a contact.
17. search contact - Search for a contact by name.

---

Note: Ensure that Node.js version 18 or higher is installed before running the application.