Titel des Projektes

Eine kurze Beschreibung des Projektes
Dokumentation »

Demo · Bug gefunden? · Feature Anfordern

• Beschreibung
  • Anforderungen
  • Installation
• Nächste Schritte
• Beiträge zu unserer Arbeit
• License
• Kontakt

Beschreibung

Hier kannst du eine Beschreibung des Projektes anfertigen, diese wird auf der GitHub Startseite zu sehen sein.

Anforderungen

Die meisten unserer Systeme sind für Ubuntu gedacht und darauf getestet worden. Viele Funktionen werden ebenfalls auf Windows verfügbar sein, allerdings können unerwartetes Verhalten und Fehler nicht ausgeschlossen werden.

Für dieses Projekt benötigst du:

• docker
  • Installationsanleitungen für docker kannst du hier finden.
• NodeJS
  • Downloads für Node stehen hier zur Verfügung.
• Einen Package Manger deiner Wahl, du kannst NPM, pNPM oder auch Yarn verwenden. Wir empfehlen pNPM da er in den meisten Situationen schneller ist und dabei das gleiche Feature Set wie NPM bietet.

Installation

1. Klone das Repository

   git clone https://github.com/IBCornelsen/repo_name.git

2. Führe docker-compose aus.

   docker-compose up --build

Nächste Schritte

• Feature 1
• Feature 2
  • Teilschritt

Siehe offene issues für eine Liste alle angeforderten Features und Bugs.

Beiträge zu unserer Arbeit

Wenn du Ideen, Vorschläge oder sonstige Anmerkungen haben solltest, schreck' nicht davor zurück dein Feature zu implementieren und eine Pull Request zu erstellen, wir sind immer offen für neues!

1. Erstelle einen Fork des Repos
2. Erstelle einen neuen Feature Branch (git checkout -b feature/AmazingFeature)
3. Committe deine Änderungen (git commit -m 'Add some AmazingFeature')
4. Pushe deine Änderungen auf den neuen Branch (git push origin feature/AmazingFeature)
5. Öffne eine Pull Request

License

Veröffentlicht unter der GPL-3.0 Lizenz. Siehe LICENSE für mehr Information.

Kontakt

IBCornelsen - info@ibcornelsen.de

Organisation: https://github.com/IBCornelsen/repo_name