phjardas / taktische-zeichen

Generator für taktische Zeichen nach der DV 102
https://taktische-zeichen.dev
MIT License
15 stars 4 forks source link
hacktoberfest react svg web-components

Taktische Zeichen

All Contributors

Bibliothek für die Erzeugung von taktischen Zeichen nach der DV 102 in JavaScript.

Dokumentation aller verfügbaren Optionen: https://taktische-zeichen.dev/

Inhalt

Die Bibliothek enthält:

Es gibt vier Bibliotheken für die Erzeugung von taktischen Zeichen, je nach Anwendungsfall.

Node.JS oder im Browser

Diese Bibliothek hat keinerlei externe Abhängigkeiten.

Installiere die Bibliothek:

npm install taktische-zeichen-core

Und so erzeugst du ein taktisches Zeichen, egal ob im Browser oder in Node.JS.

import { erzeugeTaktischesZeichen } from "taktische-zeichen-core";

const tz = erzeugeTaktischesZeichen({
  grundzeichen: "kraftfahrzeug-gelaendegaengig",
  organisation: "feuerwehr",
  fachaufgabe: "brandbekaempfung",
  einheit: "gruppe",
});

// <?xml version="1.0" encoding="UTF-8"?><svg>...</svg>
console.log(tz.toString());

// data:image/svg+xml;base64,...
console.log(tz.dataUrl);

// [75, 45]
console.log(tz.size);

React

Installiere die Bibliothek:

npm install taktische-zeichen-react

Verwende die Komponente in deiner Anwendung:

import { TaktischesZeichen } from "taktische-zeichen-react";

function App() {
  return (
    <TaktischesZeichen
      grundzeichen="kraftfahrzeug-gelaendegaengig"
      organisation="feuerwehr"
      fachaufgabe="brandbekaempfung"
      einheit="gruppe"
      {/* weitere Props werden durchgereicht */}
      className="..."
    />
  );
}

// Rendert <svg>...</svg>

Web Components

Installiere die Bibliothek:

npm install taktische-zeichen-web-component

Registriere die Komponente:

import { TaktischesZeichen } from "taktische-zeichen-web-component";

window.customElements.define("taktisches-zeichen", TaktischesZeichen);

HTML:

<taktisches-zeichen
  grundzeichen="kraftfahrzeug-gelaendegaengig"
  organisation="feuerwehr"
  fachaufgabe="brandbekaempfung"
  einheit="gruppe"
/>

Kommandozeile

Installiere die Bibliothek:

npm install taktische-zeichen-cli

Erzeuge ein taktisches Zeichen:

npm i -g taktische-zeichen-cli

taktisches-zeichen \
  --grundzeichen kraftfahrzeug-gelaendegaengig \
  --organisation feuerwehr \
  --fachaufgabe brandbekaempfung \
  --einheit gruppe

# Ausgabe auf STDOUT:
# <?xml version="1.0" encoding="UTF-8"?>
# <svg>...</svg>

Lizenz

Dieses Projekt steht unter der MIT-Lizenz und kann kostenlos verwendet werden.

Die Quellen sind öffentlich auf GitHub verfügbar.

Mitmachen

Du möchtest bei der Weiterentwicklung helfen? Prima! Du hast folgende Möglichkeiten:

Contributors

Die folgenden Personen haben an diesem Projekt mitgewirkt (Schlüssel für die Emoji). Vielen Dank!

Philipp Jardas
Philipp Jardas

💻 🖋 📖 📆
PatrickReichel
PatrickReichel

📓
einsatzverwaltung
einsatzverwaltung

💻 📓
Sascha
Sascha

💡