Skip to content

Latest commit

 

History

History
282 lines (222 loc) · 11.6 KB

readme.md

File metadata and controls

282 lines (222 loc) · 11.6 KB
Raw

The logo of Pumpn Code's template project.

🌐
Deutsch English ✍️

stars contributors forks open-issues closed-issues open-prs closed-prs

license dependencies dev-dependencies peer-dependencies

downloads version node

reddit twitter discord

website

Dies ist die primäre Vorlagen-Repository für unsere Projekte und der Ursprung aller anderen Vorlagen, weswegen sie nicht direkt für Endprodukte genutzt werden sollte. Sie beinhaltet die grundlegende Struktur und wichtige, sogenannte dotfiles.

Momentan beinhaltet sie spezifischere Dateien (zum Beispiel eine Rollup-Konfiguration), diese werden aber entfernt sobald wir 2.0.0 erreicht und eine separate Repository dafür haben.

"Unsortierte" Listen in diesem Dokument sind von oben nach unten nach Priorität sortiert, aber sind keine sortierten Markdown-Listen, weil sie keine festgelegten Sequenzen von Schritten kennzeichnen.

Dieses Dokument benutzt in einigen Fällen Emoji-Suffixe um möglicherweise deinen Einrichtungsprozess zu verschnellern, indem es Optionen markiert die du eventuell oder eben nicht berücksichtigen willst:

  • Das Suffix 💎 markiert eine empfohlene Option oder einen empfohlenen zusätzlichen Schritt.
  • Das Suffix 🤡 markiert eine mögliche aber nicht empfohlene Option.
  • Die Suffixe 🍎 (macOS), 🪟 (Windows und WSL) und 🐧 (Linux) markieren plattformspezifische Informationen oder Installationsschritte.

Einstieg

Voraussetzungen

Wenn du ein Entwickler bist, hast du folgendes oder funktionierende Alternativen womöglich schon und kannst ruhig zum Bereich Installation übergehen. Dieser Leitfaden geht davon aus, dass du Windows, Unix oder ein unixoides Betriebssystem (macOS zum Beispiel) und einen modernen Browser installiert hast. Dieses Projekt sollte auf allen denkbaren modernen System-Konfigurationen funktionieren, aber am besten solltest du eine fest etablierte und beliebte verwenden.

  • GitHub Account 💎

  • Homebrew 🍎

     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  • Git

    • macOS 🍎

      • Homebrew 💎

         brew install git

      • Direkte Installation

      • Durch Xcode 🤡

        Git über Xcode, welches ein Dutzend Gigabyte groß war und eine Stunde zum Einrichten dauerte als ich das letzte Mal nachgesehen habe, zu installieren, ist ein klassischer Pyrrhussieg. Wenn du allerdings schon Xcode hast, denke ich, dass es okay ist, "deren" Git zu verwenden.

    • Windows 🪟
    • Linux 🐧

  • Node.js

    • Installation durch nvm 💎

      • macOS, Linux & WSL 💎

        1. Installiere nvm

          curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash

        2. Installiere die neueste Node.js-Version

          nvm install node

      • Windows 🪟

        1. Installiere nvm-windows

        2. Installiere die neueste Node.js-Version

          nvm install latest

    • Direkte Installation

  • Ein Quellcode-Editor

Installation

  1. Das Template holen

    • Neue Repository durch Template erstellen 💎

      1. Klick auf "Use this template" Screenshot von "Use this template"-Button

      2. Fülle die Einzelheiten ein, markiere "Include all branches" und klick auf "Create repository from template" Screenshot vom "Create a new repository from template"-Bildschirm

      3. Klone die neue Repository

        git clone https://github.com/username/my-new-repository.git

    • Neue Repository durch Klonen erstellen 🤡

      Das würde komplett den Zweck der Template-Funktion von Github verfehlen, weil normale Klone (und Forks) die gesamte Commit-History (und andere Dinge), aber nicht alle Branches kopieren, was normalerweise nicht das ist, was du willst, wenn du ein neues Projekt basierend auf einem Boilerplate erstellst. Hier mehr dazu.

      1. Klone diese Repository in einen neuen Ordner

        git clone https://github.com/pumpncode/template.git my-new-repository

  2. Einrichtung

    1. Gehe zu deinem neuen Repository-Ordner

      cd my-new-repository

    2. Installiere die Abhängigkeiten

      npm install

Nutzung

Das dieses Projekt ein Vorlage ist, hängt die Nutzung ganz davon ab, welches Ziel dein neues Projekt verfolgt. Sobald alles installiert ist, kannst du ausprobieren die Scripts in der package.json auszuführen, diese nutzen praktisch alle anderen Funktionen dieses Templates.

helloWorld

Dies ist eine Hello-World-Funktion

Beispiele

console.log(helloWorld()); // gibt "Hello World!" in der Konsole aus

Gibt string "Hello World!" zurück.

Roadmap

Sieh dir die derzeitigen Projekte und offenen Issues für eine Liste von vorgeschlagenen Features und bekannten Fehlern an.

Mitwirken

Jegliches Mitwirken wird sehr geschätzt.

Siehe contributing.md um loszulegen.

Dieses Projekt hat einen Verhaltenskodex. Durch das Interagieren mit dieser Repository, stimmst du zu, seinen Bedingungen zu folgen.

Kontakt

Pumpn Code - office@pumpn.net

Nano Miratus - @nnmrts - nanomiratus@gmail.com

Projekt-Link: https://github.com/pumpncode/template

Danksagung

Mitwirkende

Name Website GitHub Twitter
Nano Miratus https://pumpn.net/ @nnmrts @nnmrts

Lizenz

MIT © Pumpn Code