ReadMeAI

? Readmeai?

Überblick

Der ReadMe-Generator ist eine Plattform, mit der Benutzer einen Einzelfilmcode hochladen und ihr Projekt beschreiben können. Die KI generiert einen Markdown-Code, der mit einem Code-Editor in Echtzeit bearbeitet werden kann, und die Änderungen werden sofort vorübergenommen.

Readmeai ist jetzt live bei readmeai.live

Navigation

• ? Readmeai?
  • Überblick
  • Navigation
  • ? Merkmale
  • Dateistruktur (MVC)
  • Tech Stack
  • Installation
    • In Ihrer lokalen Maschine
    • In Ihrer virtuellen Maschine (mit Docker)
  • Verwendung
    • In Ihrer lokalen Maschine
    • Verwenden von Docker -Container
  • ? Funktionen für die nächste Version.
  • ?Unterstützung
  • ✍️ Autoren

? Merkmale

• KI-betriebene Inhalte : Sie verwendet Google AI, um aussagekräftige und informative Inhalte für Ihre Readme zu generieren, einschließlich Projektbeschreibung, Verwendung, Installation und vielem mehr.

• Anpassung : Sie können den generierten Inhalt mit einem integrierten Editor anpassen, um bestimmte Abschnitte einzuschließen oder auszuschließen, um sicherzustellen, dass Ihr Readme die individuellen Anforderungen Ihres Projekts widerspiegelt.

• Markdown -Unterstützung : Die generierten ReadMe -Dateien verwenden Markdown, wodurch Sie Ihre Projektdokumentation einfach formatieren und stylen können.

• Benutzerfreundliche Weboberfläche : Greifen Sie über eine benutzerfreundliche Weboberfläche auf den Generator zu und beseitigen Sie die Bedürfnisse für manuelle Einrichtung.

Dateistruktur (MVC)

• ? API/ : Enthält eine Codedatei zur Verbindung zu APIs von Drittanbietern (Google Palm 2)
• ? Controller/ : Enthält die gesamte Geschäftslogik, um auf Post-/ GET -Anforderungen auszuführen.
• ? Ansichten/ : Enthält Dateien, die auf den Client -Seiten rendern.
• ? Daten/ : Enthält die "Vorlage" , die die Ausgabemodell und "output.md" enthält, die den Ausgangsmarktdown ausgibt.
• ? öffentlich/ : Enthält CSS und Skripte der Client -Seite.
• ? Routen/ : Datei, um Routen zu verarbeiten und die jeweilige Controller -Funktion auf einer bestimmten Route aufzurufen.
• ? Uploads/ : In diesem Verzeichnis werden Dateien enthalten, die Server von der Client -Seite empfangen werden, und löscht sie dann, sobald die Sitzung endet.
• ? server.js : Diese Datei ist der Haupt -Express -Server . Dies ist die Datei, die auf dem Startserver ausgeführt wird.
• ? DockerFile : Diese Datei enthält ein Skript zum Containerieren von Projekten.

Tech Stack

• Node.js: serverseitige Laufzeit.
• Express: node.js Framework.
• ? Google Palm API: Das Google Pathways-Sprachmodell ist ein 540-Milliarden-Parameter-Transformator-basiertes Großsprachmodell.
• ? EJS: Templating Engine zum Rendern und Fügen Sie dynamischen Inhalt in Ihrem HTML auf dem Server.
• ? CSS: Styling der HTML -Vorlage.
• JavaScript: Um Interaktivität im Frontend hinzuzufügen.

Installation

In Ihrer lokalen Maschine

1. Klonen Sie das Repository.
2. Navigieren Sie zum Projektverzeichnis.
3. Öffnen Sie Ihr Terminal und laufen Sie:

    npm install

In Ihrer virtuellen Maschine (mit Docker)

1. Klonen Sie das Repo und navigieren Sie zum Projektverzeichnis.
2. Öffnen Sie den Terminal und geben Sie den folgenden Befehl ein:

     docker build -t gitax18/readmeai . 

Verwendung

In Ihrer lokalen Maschine

1. Wechsel zum Projektverzeichnis.
2. Öffnen Sie Ihr Terminal und geben Sie den folgenden Befehl ein:

    npm start

3. Die Anwendung wird unter http: // localhost: 3333 ausgeführt

Verwenden von Docker -Container

1. Geben Sie den folgenden Befehl ein, um den Container zu starten:

    docker run -it -p 3333:3333 gitax18/readmeai

2. Jetzt wird die Anwendung unter http: // localhost: 3333 ausgeführt

---

Hinweis: Wenn das Projekt nicht ordnungsgemäß ausgeführt wird und den CRBUG -Fehler in der Webkonsole anzeigen, befolgen Sie die folgenden Schritte.

1. Öffnen Sie die VSCODE A GEMENE IN VERSAMEN UND DEBUG IN LINKEN SEITEBAR.
2. Klicken Sie auf "Erstellen Sie eine Datei für starten.json" und wählen Sie im Popup-Menü node.js.
3. Klicken Sie nun auf dem gleichen Triangular Play -Symbol oben auf demselben Sidebar "Run and Debugug".
4. Gehen Sie jetzt zu http: // localhost: 3333

? Funktionen für die nächste Version.

• GitHub -Autorisierung zum Hinzufügen von Repo anstelle einer einzelnen Datei.
• Mehr ausgebildete KI, um Readme für Ordner als Datei zu generieren.
• Benutzerdefinierte Vorlagen können definieren, welche Funktionen/Abschnitt sie in ihrem Readme wünschen.

?Unterstützung

Wenn Sie auf Probleme stoßen oder Fragen haben, können Sie bitte ein Problem im Repository erstellen. Wir sind hier, um zu helfen!

✍️ Autoren

• Gitanshu Sankhla (Backend Developer) -

• Vijay Banjara (Frontend -Entwickler) -
  

• Harsh Kumar (Designer) -