ReadMeAI

? ReadMeai?

Aperçu

Le générateur ReadMe est une plate-forme qui permet aux utilisateurs de télécharger un code unique et de décrire leur projet. L'IA génère un code Markdown, qui peut être modifié en temps réel à l'aide d'un éditeur de code, et les modifications sont présentées instantanément.

ReadMeai est maintenant en direct sur ReadMai.Live

Navigation

• ? ReadMeai?
  • Aperçu
  • Navigation
  • ? Caractéristiques
  • Structure de fichiers (MVC)
  • Pile technologique
  • Installation
    • Dans votre machine locale
    • Dans votre machine virtuelle (en utilisant Docker)
  • Usage
    • Dans votre machine locale
    • Utilisation du conteneur Docker
  • ? Fonctionnalités pour la prochaine version.
  • ?Soutien
  • ✍️ Auteurs

? Caractéristiques

• Contenu alimenté par AI : il utilise Google AI pour générer du contenu significatif et informatif pour votre lecture, y compris la description du projet, l'utilisation, l'installation, etc.

• Personnalisation : vous pouvez personnaliser le contenu généré à l'aide d'un éditeur intégré pour inclure ou exclure des sections spécifiques, en vous assurant que votre lecture reflète les besoins uniques de votre projet.

• Prise en charge de Markdown : les fichiers de lecture générés utilisent Markdown, ce qui facilite le format et le style de la documentation de votre projet.

• Interface Web conviviale : accédez au générateur via une interface Web conviviale, en éliminant le besoin d'une configuration manuelle.

Structure de fichiers (MVC)

• ? API / : contient un fichier de code pour se connecter aux API tiers (Google Palm 2)
• ? Controllers / : contient toute la logique métier à exécuter sur les demandes de poste / get.
• ? Vues / : contient des fichiers à rendre sur les côtés du client.
• ? Data / : contient le «modèle» qui maintiendra le modèle de sortie et «output.md» qui sortira Markdown.
• ? public / : contient le côté client CSS et scripts.
• ? Routes / : fichier pour gérer les routes et appeler la fonction de contrôleur respective sur une route particulière.
• ? Téléchargements / : Ce répertoire conservera les fichiers que le serveur a reçues du côté client, puis les supprime une fois la session terminée.
• ? server.js : ce fichier est le principal serveur express , c'est le fichier qui s'exécutera sur le serveur de démarrage.
• ? Dockerfile : ce fichier contient un script dans le projet de contenerize.

Pile technologique

• Node.js: l'exécution côté serveur.
• Framework Express: Node.js.
• ? Google Palm API: Google Pathways Language Model est un modèle de langue grand transformateur de 540 milliards de paramètres basés sur un transformateur.
• ? EJS: Templage du moteur pour rendre et ajouter du contenu dynamique dans votre HTML chez Server.
• ? CSS: styliser le modèle HTML.
• JavaScript: pour ajouter l'interactivité dans le frontend.

Installation

Dans votre machine locale

1. Clone le référentiel.
2. Accédez au répertoire du projet.
3. Ouvrez votre terminal et courez:

    npm install

Dans votre machine virtuelle (en utilisant Docker)

1. Clone le repo et accédez au répertoire du projet.
2. Ouvrez le terminal et tapez la commande suivante:

     docker build -t gitax18/readmeai . 

Usage

Dans votre machine locale

1. Passer au répertoire du projet.
2. Ouvrez votre terminal et saisissez la commande suivante:

    npm start

3. L'application s'exécutera sur http: // localhost: 3333

Utilisation du conteneur Docker

1. Pour démarrer le conteneur, saisissez la commande suivante:

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

2. Maintenant, l'application fonctionnera sur http: // localhost: 3333

---

Remarque: Si le projet ne s'exécute pas correctement et affichez l'erreur CRBUG dans la console Web, suivez les étapes suivantes.

1. Ouvrez VScode un menu «Exécuter et déboguer» dans la barre latérale gauche.
2. Cliquez sur «Créer un fichier lancé.json» et sélectionnez Node.js dans le menu contextuel.
3. Cliquez maintenant sur l'icône de jeu triangulaire vert en haut de la même barre latérale «Run and Debug».
4. Maintenant, allez sur http: // localhost: 3333

? Fonctionnalités pour la prochaine version.

• Autorisation GitHub à ajouter un repo plutôt que un seul fichier.
• IA plus formée pour générer des dossiers de lecture pour les dossiers plutôt que le fichier.
• Modèles personnalisés, l'utilisateur peut définir les fonctionnalités / section qu'ils veulent dans leur lecture.

?Soutien

Si vous rencontrez des problèmes ou si vous avez des questions, n'hésitez pas à créer un problème sur le référentiel. Nous sommes là pour aider!

✍️ Auteurs

• Gitanshu Sankhla (développeur backend) -

• Vijay Banjara (développeur Frontend) -
  

• Harsh Kumar (concepteur) -