makeread.me download - makeread.me Quellcode herunterladen

makeread.me

Website-Daten

1.0.0

Herunterladen

makeread.me

Ein großartiger Readme -Generator, um Ihre Projekte zu starten!

Erforschen Sie die Dokumente »

Demo anzeigen. Fehler melden. Anforderungsfunktion

Inhaltsverzeichnis

Inhaltsverzeichnis
Über das Projekt
- Gebaut mit
Erste Schritte
- Voraussetzungen
- Installation
Roadmap
Beitragen
Lizenz
Kontakt
Anerkennung
Beachten

Über das Projekt

Screenshot

Eine der Herausforderungen beim Aufbau und bei Beitrag zu Open-Source-Software besteht darin, dass viele Projekte jedoch erstaunliche Funktionen haben, sie jedoch häufig das Erreichen eines breiteren Publikums verpassen, da es keine klaren und benutzerfreundlichen Installationsanweisungen fehlt. Darüber hinaus tragen mangelnde effiziente Präsentation ihrer Anwendungsfälle auch zur geringeren Reichweite dieser Projekte bei.

Während es ReadMe-Vorlagen gibt, die dazu beitragen können, dies zu beheben, kann der Prozess des manuellen Ausfüllens dieser Vorlagen zeitaufwändig und mühsam sein. Hier kommt unser Projekt Makeread.me ins Spiel.

Einführung von Makeread.me, einem automatisierten Readme -Generator, mit dem Sie Ihre Projektdokumentation erstellen können. Es ist so konzipiert:

Speichern Sie Ihre wertvolle Zeit, um Ihren Fokus auf die Entwicklung zu verbessern.
Automatisieren redundante Aufgaben und,
Implementieren Sie trockene Prinzipien (nicht wiederholen Sie sich) in Ihre Dokumentation.

Es ist kostenlos, Open-Source und sehr anpassbar. Fühlen Sie sich frei, unsere Vorlagen so zu ändern, dass Sie Ihren Anforderungen entsprechen. Wenn Sie feststellen, dass eine bestimmte Komponente fehlt, können Sie das Projekt mehr als willkommen leisten und erweitern.

Wir haben es Ihnen leicht gemacht, zum Projekt beizutragen, indem Sie Nunjucks und JSON -Vorlagen für die programmatische Zuordnung verwenden. Genießen Sie die Vorteile einer klaren und prägnanten Projektdokumentation bei Makeread.me!

Gebaut mit

Dieses Projekt wurde mit den folgenden Technologien erstellt:

Weiter.js
Reagieren
Shadcn/Ui
Hakenform reagieren
Typoskript
Äußern

Erste Schritte

Dies ist ein Beispiel dafür, wie Sie Anweisungen zum Einrichten Ihres Projekts vor Ort geben können. Um eine lokale Kopie in Betrieb zu nehmen, führen Sie diesen einfachen Beispielschritten aus.

Voraussetzungen

In diesem Projekt muss Garn in Ihrem System installiert werden. Wenn Sie es nicht installieren lassen, können Sie folgende Schritte befolgen:

Installieren Sie Garns weltweit mit NPM (Knotenpaketmanager). Öffnen Sie Ihr Terminal und laufen Sie:
```
npm install -g yarn
```
Bitte stellen Sie sicher, dass Sie vor dem Ausführen von Garn über Node.js und NPM installiert sind.
Stellen Sie sicher, dass das Garn auf Ihrem Computer installiert wurde, indem Sie den folgenden Befehl in Ihrem Terminal ausführen:
```
yarn --version
```
Wenn das Garn korrekt installiert wurde, sollte Ihr Terminal die auf Ihrem Maschine installierte Version des Garns anzeigen.

Jetzt sind Sie bereit, Garn für die Verwaltung und Versionierung Ihrer Projektabhängigkeiten zu verwenden!

Installation

Bitte befolgen Sie die folgenden Schritte für eine erfolgreiche Installation:

Klonen Sie das Repository: Beginnen Sie mit dem Klonen des Repositorys in Ihre lokale Maschine.
```
 https://github.com/ShaanCoding/makeread.me
```
Installieren Sie Frontend -Pakete: Navigieren Sie zum Verzeichnis "/Frontend" und installieren Sie die erforderlichen Garnpakete, indem Sie den folgenden Befehl in Ihrem Terminal ausführen:
```
yarn install
```
Installieren Sie Backend -Pakete: Navigieren Sie in ähnlicher Weise zum Verzeichnis "/Backend" und installieren Sie die erforderlichen Garnpakete, indem Sie den folgenden Befehl in Ihrem Terminal ausführen:
```
yarn install
```
Umgebung einrichten:
- Kopieren Sie im Verzeichnis "/Backend" den Inhalt von ".env.example" und erstellen Sie eine neue Datei namens ".env". Passen Sie die Umgebungsvariablen entsprechend Ihren Anforderungen an oder Sie können sie so belassen.
- Navigieren Sie zu "Frontend/API/generiert/readMegenerator.ts" und setzen Sie den Basisparameter auf Ihre Backend -API -Route. Wenn Sie beispielsweise Backend auf Ihrem lokalen Server unter Port 8080 ausführen, sollten Sie festlegen:
```
BASE: "http://localhost:8080/api" ;
```
Führen Sie das Backend aus: Navigieren Sie zum Verzeichnis "/Backend" und geben Sie den folgenden Befehl in Ihr Terminal ein, um Ihren Backend -Server auszuführen:
```
yarn dev
```
Führen Sie das Frontend aus: Navigieren Sie schließlich zum Verzeichnis "/Frontend" und geben Sie den folgenden Befehl in Ihr Terminal ein, um Ihren Frontend -Server auszuführen:
```
yarn dev
```
Jetzt sollte Ihre Bewerbung erfolgreich in Betrieb sein!

Roadmap

Die Roadmap umfasst sowohl abgeschlossene als auch zukünftige Ziele. Folgendes haben wir erreicht und freuen uns:

Wir setzen unser Engagement für die Verbesserung und Erweiterung der Fähigkeiten von Makeread.me fort, um unseren Benutzern ein effizientes und nahtloses Erlebnis der Readme -Generation zu bieten.

In den offenen Problemen finden Sie eine vollständige Liste der vorgeschlagenen Merkmale (und bekannten Probleme).

Beitragen

Beiträge machen die Open -Source -Community zu einem erstaunlichen Ort, um zu lernen, zu inspirieren und zu kreieren. Alle Beiträge, die Sie leisten, werden sehr geschätzt .

Wenn Sie einen Vorschlag haben, der dies besser machen würde, geben Sie bitte das Repo und erstellen Sie eine Pull -Anfrage. Sie können auch einfach ein Problem mit dem Tag "Verbesserung" eröffnen. Vergessen Sie nicht, dem Projekt einen Stern zu geben! Danke noch einmal!