Matrix-Configurator

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage

About The Project

The Questlog Matrix Configurator is a browser tool, which increases the level of automization, standardization and quality assurance in the production process by:

• Providing an interactive React-based UI that allows the laser-cutter specialist to arrange country silhouettes based on demand
• Allowing the user to define country-specific offsets to ensure exact configuration across time
• Delivering a SVG Matrix on-click that can be consumed seamlessly by the laser-cutter software

(back to top)

Built With

• React.js
• Node.js
• Express

(back to top)

Getting Started

1. Clone the repo

   git clone https://github.com/Manuel-Bauer/questlog-matrix-configurator.git

2. Navigate to folder "frontend" and install NPM packages

   cd frontend
   npm install

(back to top)

Usage

1. Save country silhouette SVGs in folder /server/img/countries and name them according to the country's name
2. To start Matrix-Configurator on an Apple or Linux OS navigate to the project folder and enter

 npm run dev

On a Windows OS enter

 start npm start & cd frontend & npm start

A browser window with the Matrix-Configurator UI will start automatically.

3. Select the country silhouette for each matrix grid in dropdown menu
4. If default position of a specific country needs to be changed, navigate to frontend/src/config and adjust x and y offset for country. Offset is be 0 for x and y by default.
5. Once finished, hit the save button.
6. In the folder server/img/matrix you will find the laser-cutter-ready SVG with an unique ID.

(back to top)