# Installation Many solutions are availble : 1. Node application in dev mode (not compiled) 2. Node application id Production mode (compiled) 3. Docker container # Instructions **WASPL - Digital Assessment Platform (Alpha)** Status: Alpha License: AGPL v3 Technology Stack: Node.js, Vue 3, MongoDB, Docker --- ### 🧭 Table of Contents - Overview - Features - Architecture - Getting Started - Local Development (no Docker) - Docker Usage - Development Mode (hot-reload) - Production Mode (with NGINX) - Available `make` Commands - Environment Variables - Quick Setup (Development) - Configuration File Structure - Production Configuration - Security - Interaction Types - Default User - Project Structure - Contributing - License --- ### 📘 Overview WASPL is an open-source digital assessment platform designed to create, manage, and deliver interactive online tests. Built with modern technologies (Node.js, Vue 3, MongoDB, Docker), it provides educators with powerful tools to design rich and flexible testing experiences. **⚠️ Pre-Alpha Version**: This software is in active development and not yet ready for production use. --- ### ✨ Features - **Waspleditor**: Create tests using 12 interactive question types. - **WasplTestRunner**: Deliver assessments in EXAM or LEARNING mode. - Rich interactions: drag-and-drop, clickable images, gap-fills, and more. - **AI Integration**: Automatic scoring and test generation. - **Internationalization**: Supports 6 languages (EN, FR, ES, DE, IT, PT). - **MongoDB**: Stores responses and metadata. - **Strict ESM**: Modern modular imports everywhere. --- ### 🧱 Architecture WASPL consists of two main applications: - `waspleditor`: Admin/editor interface to build tests. - `waspltestrunner`: Interface for test takers. Both apps use a shared backend and a MongoDB database. Services are orchestrated with Docker. Full documentation is available at: [https://waspl-wiki.wiquid.fr/](https://waspl-wiki.wiquid.fr/) --- ### 🚀 Getting Started #### 🔧 Local Development (no Docker) 1. Clone the repository: 2. Install dependencies: 3. Start MongoDB manually (if needed), then: Pre-configured `.env` files are included with safe default values. #### 🐳 Docker Usage ##### 🧪 Development Mode (hot-reload) Command: - Waspleditor: [http://localhost:5173](http://localhost:5173) - WasplTestRunner: [http://localhost:5174](http://localhost:5174) Services wait for MongoDB before launching. ##### 🚀 Production Mode (with NGINX) Command: - Single entry point: [http://localhost/](http://localhost/) - `/editor/` for the editor - `/runner/` for test-taking NGINX handles redirection, security headers, and gzip compression. ##### ⚙️ Available `make` Commands

Command	Description
`make dev`	Start all services in dev mode
`make prod`	Start all services in production mode
`make down`	Stop and remove containers
`make reset-db`	Remove MongoDB local data
`make reset-all`	Remove all containers, data and Docker images

--- ### ⚙️ Environment Variables #### 🚀 Quick Setup (Development) Everything works out of the box after cloning: #### 📁 Configuration File Structure

File	Included	Description
`.env`	✅ Yes	Base development configuration
`.env.docker`	✅ Yes	Docker-specific configuration
`.env.template`	✅ Yes	Example with placeholders
`.env.local`	❌ No	Local custom variables (ignored)
`.env.production`	❌ No	Sensitive production configuration

#### 🔧 Production Configuration Create a `.env.local` file with real values: Or use system environment variables: #### 🛡️ Security - ✅ Development files use safe defaults and are included - ❌ Real secrets are excluded from Git - 🔄 Templates are available to simplify setup --- ### 🎯 Interaction Types WASPL supports 12 interaction types: - **Choice**: Classic single or multiple choice - **Choice Block**: Choice with rich media support - **Text Puzzle**: Drag-and-drop gap-filling puzzle - **Text Gaps**: Traditional fill-in-the-blank text - **Short Answer**: Free-form answer with AI scoring - **Hot Spot**: Clickable image-based interactions - **Order**: Sequencing with drag-and-drop - **Match**: Match pairs between two columns - **Making Pairs**: Build and assign item pairs - **Message**: Instructional text without input - **No Editor**: Raw content mode - **Default**: Custom base interaction --- ### 🔑 Default User Default credentials: - Username: `admin` - Password: `password` --- ### 📂 Project Structure --- ### 🤝 Contributing We welcome contributions! Open an issue or submit a pull request. Please follow the existing code style and use meaningful commit messages. #### 🔧 Setup for Contributors 1. Clone the repo: 2. (Optional) Enable AI features: 3. Recommended: use Docker --- ### 📝 License This project is licensed under the **AGPL v3**. See the LICENSE file for details.