ReadMeAI

？ readmeai？

概要

READMEジェネレーターは、ユーザーが単一ファイルコードをアップロードしてプロジェクトを説明できるプラットフォームです。 AIは、コードエディターを使用してリアルタイムで編集できるマークダウンコードを生成し、変更は即座にプレビューされます。

readmeaiは現在、readmeai.liveに住んでいます

ナビゲーション

• ？ readmeai？
  • 概要
  • ナビゲーション
  • ？特徴
  • ファイル構造（MVC）
  • 技術スタック
  • インストール
    • あなたのローカルマシンで
    • 仮想マシン（Dockerを使用）
  • 使用法
    • あなたのローカルマシンで
    • Dockerコンテナを使用します
  • ？次のリリースの機能。
  • ？サポート
  • ✍authors著者

？特徴

• AI搭載コンテンツ：Google AIを使用して、プロジェクトの説明、使用法、インストールなど、READMEの意味のある有益なコンテンツを生成します。

• カスタマイズ：組み込みのエディターを使用して生成されたコンテンツをカスタマイズして、特定のセクションを含めるか除外して、READMEがプロジェクトの独自のニーズを反映していることを確認できます。

• マークダウンサポート：生成されたREADMEファイルはMarkDownを使用して、プロジェクトのドキュメントを簡単にフォーマットしてスタイリングできます。

• ユーザーフレンドリーなWebインターフェイス：ユーザーフレンドリーなWebインターフェイスを介してジェネレーターにアクセスし、手動セットアップの必要性を排除します。

ファイル構造（MVC）

• ？ API/ ：サードパーティAPI（Google Palm 2）に接続するコードファイルを含む
• ？コントローラー/ ：投稿/ Getリクエストで実行するためのすべてのビジネスロジックが含まれています。
• ？ビュー/ ：クライアント側にレンダリングするファイルが含まれています。
• ？データ/ ：出力テンプレートと「output.md」を保持する「テンプレート」が含まれています。
• ？ public/ ：クライアント側のCSSとスクリプトが含まれています。
• ？ルート/ ：ルートを処理し、特定のルートでそれぞれのコントローラー関数を呼び出すためのファイル。
• ？アップロード/ ：このディレクトリは、サーバーがクライアント側から受信したファイルを保持し、セッションが終了すると削除します。
• ？ server.js ：このファイルはメインエクスプレスサーバーであり、これはStart Serverで実行されるファイルです。
• ？ DockerFile ：このファイルには、プロジェクトをコンテナ化するスクリプトが含まれています。

技術スタック

• node.js：サーバー側のランタイム。
• Express：node.jsフレームワーク。
• ？ Google Palm API：Google Pathways Languageモデルは、5,400億のパラメーター変圧器ベースの大手言語モデルです。
• ？ EJS：サーバーのHTMLに動的コンテンツをレンダリングおよび追加するテンプレートエンジン。
• ？ CSS：HTMLテンプレートのスタイリング。
• JavaScript：フロントエンドにインタラクティブ性を追加します。

インストール

あなたのローカルマシンで

1. リポジトリをクローンします。
2. プロジェクトディレクトリに移動します。
3. ターミナルを開いて実行します。

    npm install

仮想マシン（Dockerを使用）

1. リポジトリをクローンして、プロジェクトディレクトリに移動します。
2. 端子を開き、次のコマンドを入力します。

     docker build -t gitax18/readmeai . 

使用法

あなたのローカルマシンで

1. プロジェクトディレクトリに変更します。
2. 端末を開き、次のコマンドを入力します。

    npm start

3. アプリケーションはhttp：// localhost：3333で実行されます

Dockerコンテナを使用します

1. コンテナを起動するには、次のコマンドを入力してください。

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

2. これで、アプリケーションはhttp：// localhost：3333で実行されます

---

注：プロジェクトが適切に実行されず、WebコンソールにCRBUGエラーが表示されない場合は、次の手順に従います。

1. VSCODEを開き、左サイドバーの「実行とデバッグ」メニューに移動します。
2. [Launch.jsonファイルの作成]をクリックし、[ポップアップ]メニューで[node.js]を選択します。
3. 次に、同じ「実行とデバッグ」サイドバーの上部にある緑色の三角形の再生アイコンをクリックします。
4. 次に、http：// localhost：3333にアクセスします

？次のリリースの機能。

• GitHubは、単一のファイルではなくレポを追加する許可を与えます。
• ファイルではなくフォルダーのREADMEを生成するために、より訓練されたAI。
• カスタムテンプレートでは、ユーザーはREADMEで必要な機能/セクションを定義できます。

？サポート

問題が発生したり、質問がある場合は、リポジトリで問題を作成してください。私たちは助けにここにいます！

✍authors著者

• Gitanshu Sankhla（バックエンド開発者） -

• Vijay Banjara（Frontend Developer） -
  

• Harsh Kumar（デザイナー） -