Map WYSIWYG Editor
- Description of the Feature
- Map WYSIWYG Editor is a tool that allows users to create and edit maps in a graphical way.
- Author
- Sarah Poloczek
- Implemented During
- Praxisprojekt Informatik Bachelor
- Status
- finished, but not yet reviewed and merged
- Repositories
-
- https://gitlab.com/the-microservice-dungeon/core-services/map-editor: new repository containing the Map editor client
- https://gitlab.com/the-microservice-dungeon/core-services/map (Branch map-editor): added REST interface to control the map creation and editing
- https://gitlab.com/the-microservice-dungeon/docs (Branch MapEditor): documentation on how to use the editor client
- Last Update
- 2025-02-04
Hint
This following part of the documentation is embedded from the README of the map-editor repository. If you experience any issues on this page, just visit the repository directly.map-editor
This template should help get you started developing with Vue 3 in Vite.
Recommended IDE Setup
- VSCode
- Volar as a Vue plugin (and disable Vetur)
Type Support for .vue
Imports in TS
TypeScript cannot handle type information for .vue
imports by default, so we replace the tsc
CLI with vue-tsc
for type checking. In editors, we need TypeScript Vue Plugin Volar to make the TypeScript language service aware of .vue
types.
If the standalone TypeScript plugin doesn’t feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:
- Disable the built-in TypeScript Extension
- Run
Extensions: Show Built-in Extensions
from VSCode’s command palette - Find
TypeScript and JavaScript Language Features
, right click and selectDisable (Workspace)
- Run
- Reload the VSCode window by running
Developer: Reload Window
from the command palette.
Customize configuration
See Vite Configuration Reference.
Project Setup
npm install
Compile and Hot-Reload for Development
npm run dev
Type-Check, Compile and Minify for Production
npm run build
Run Unit Tests with Vitest
npm run test:unit
Run End-to-End Tests with Nightwatch
# When using CI, the project must be built first.
npm run build
# Runs the end-to-end tests
npm run test:e2e
# Runs the tests only on Chrome
npm run test:e2e -- --env chrome
# Runs the tests of a specific file
npm run test:e2e -- tests/e2e/example.ts
# Runs the tests in debug mode
npm run test:e2e -- --debug
Run Headed Component Tests with Nightwatch Component Testing
npm run test:unit
npm run test:unit -- --headless # for headless testing
Lint with ESLint
npm run lint