easyreadme

? Überblick

EasyReadme ist ein Projekt, das die Readmeerstellung vereinfacht, indem sie visuell atemberaubende Readmes mit vorab gestalteten Vorlagen und KI erzeugen. Es unterstützt die Generierung von ReadMes für JavaScript/TypeScript-, Rost-, Java-, Go-, PHP- und Python -Projekte. Es stützt sich auf eine Vielzahl von Technologien und Bibliotheken, darunter React, Tailwind CSS, Zehenspitzen, OpenAI und mehr.

? Inhaltsverzeichnis

• ❤️ Funktionen

• Stapel

• Projektzusammenfassung

• Einrichten

• Vor Ort laufen

• Roadmap

• Anerkennung

• ? Lizenz

Merkmale

Einführung.mp4

Liste der Vorlagen

templates.mp4

Passen Sie Readme an

anpassen.mp4

AI -Abschnitte

AI-Sektionen.MP4

Inline -Befehle

Befehls.mp4

Blasenmenü

Bubble-Menu.mp4

Editable Bannerbild -URL

Update-Banner.mp4

Kostenlose KI -Credits, benutzerdefinierte API -Schlüssel, lokaler Lauf

API-offline-Generationen.mp4

Stapel

• Weiter: Ein Framework zum Erstellen servergerenderter React-Anwendungen.
• React: Eine JavaScript -Bibliothek zum Erstellen von Benutzeroberflächen.
• TypeScript: Ein typisiertes Superet von JavaScript, das mit Plain JavaScript kompiliert.
• Shadcn/UI: Bietet wunderschön gestaltete Komponenten für die Benutzeroberfläche.
• Tailwindcss: Ein Utility-First CSS-Framework für die schnelle UI-Entwicklung.
• Vaul: Eine nicht styled Schubladenkomponente für React.
• SONNER: Eine munsikalische Toastkomponente für React.
• Zehenspitzen/Kern: Ein hoch anpassbarer und erweiterbarer Rich -Texteditor -Framework.
• SWR: Verarbeitet das Abrufen, Zwischenspeichern und Synchronisation mit dem Server.
• Zustand: Eine kleine, schnelle und skalierbare staatliche Verwaltungsbibliothek.
• Lucide: Schöne und konsequente Ikonen.

Projektzusammenfassung

• SRC : Primäres Quellcodeverzeichnis.
• SRC/App : Enthält die Hauptanwendungslogik und Komponenten.
• SRC/Komponenten : Häuser wiederverwendbare UI -Komponenten.
• SRC/Hooks : benutzerdefinierte React -Hooks zum Verwalten von Status und Nebenwirkungen.
• SRC/LIB : Versorgungsfunktionen und Helfermodule.
• SRC/Dienste : Module für die Interaktion mit externen APIs.
• SRC/Stile : Globale Stile und CSS -Module.
• SRC/Typen : TypeScript -Typdefinitionen.
• SRC/Utils : Verschiedene Dienstprogrammfunktionen.
• Öffentlich : öffentliches Verzeichnis für statische Vermögenswerte und Erstellung der Produktion.

Einrichten

Openai_api_key

• Gehen Sie zur OpenAI -Website.
• Melden Sie sich in Ihrem Konto an oder erstellen Sie eine neue.
• Navigieren Sie zu Ihren API -Einstellungen.
• Generieren Sie einen geheimen Schlüssel.
• Kopieren Sie den generierten geheimen Schlüssel.

Github_access_token

• Gehen Sie zur GitHub -Website.
• Melden Sie sich in Ihrem Konto an oder erstellen Sie eine neue.
• Navigieren Sie zu Ihren Kontoeinstellungen.
• Gehen Sie zum Abschnitt "Entwicklereinstellungen".
• Generieren Sie ein neues persönliches Zugangs -Token mit den erforderlichen Berechtigungen.

Kv_rest_api_url und kv_rest_api_token

• Gehen Sie zur Vercel -Website.
• Melden Sie sich in Ihrem Konto an oder erstellen Sie eine neue.
• Navigieren Sie zum Speicherbereich.
• Erstellen Sie eine neue KV -Datenbank.
• Kopieren Sie die kv_rest_api_url und kv_rest_api_token unter der Registerkarte .env.local .

Ollama_url

• Laden Sie Ollama herunter und lassen Sie es laufen.
• Wenn Ihre Instanz von Ollama nicht auf der Standard-IP-Adress und Port und Port ausgeführt wird, ändern Sie die Variable in der Datei .env.example, um Ihre UseCase anzupassen

Vor Ort laufen

1. Kleine das EasyReadme -Repository:

git clone https://github.com/xavimondev/easyreadme

2. Nennen Sie das .env.example nach .env :

mv .example.env .env

3. Installieren Sie Abhängigkeiten:

 # bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install

6. Starten Sie den Entwicklungsmodus:

 # bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev

Wichtig

Trotz einer Vorlage für NPM -Pakete gibt es noch viel zu tun und zu recherchieren, wie die richtigen Typen aus Paketen erhalten können.

Roadmap

• Fügen Sie Unterstützung für weitere Programmiersprachen hinzu.
• Fügen Sie "mit Emojis" Option hinzu.

Anerkennung

• Die Sparkles -Animation stammte aus dieser großartigen Ressource von Josh W. Comeau
• Die Konfetti rund um die Schaltfläche "Code kopieren" wurde mit dem Lucide -Web als Referenz erstellt.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der MIT -Lizenzdatei .