？概要
EasyReadMeは、事前に設計されたテンプレートとAIを使用して視覚的に見事なREADMEを生成することにより、READMEの作成を簡素化するプロジェクトです。 JavaScript/Typescript、Rust、Java、Go、PHP、およびPythonプロジェクトのReadmesの生成をサポートしています。 React、Tailwind CSS、Tiptap、Openaiなどを含む幅広いテクノロジーとライブラリに依存しています。
？目次
phatureatyfeations
スタック
プロジェクトの概要
セットアップ
ローカルで実行します
？§ロードマップ
謝辞
？ライセンス
特徴
はじめに。mp4
テンプレートのリスト
templates.mp4
readmeをカスタマイズします
Customize.mp4
AIセクション
ai-sections.mp4
インラインコマンド
commands.mp4
バブルメニュー
Bubble-Menu.mp4
編集可能なバナー画像URL
update-banner.mp4
無料のAIクレジット、カスタムAPIキー、ローカルラン
API-Offline-Generations.mp4
スタック
- 次：サーバーレンダリングアプリケーションを構築するためのフレームワーク。
- React：ユーザーインターフェイスを構築するためのJavaScriptライブラリ。
- タイプスクリプト：Plain JavaScriptにコンパイルするJavaScriptのタイプ付きスーパーセット。
- ShadCn/UI：UI用に美しく設計されたコンポーネントを提供します。
- TailWindCSS：迅速なUI開発のためのユーティリティファーストCSSフレームワーク。
- Vaul：Reactのスタイルのない引き出しコンポーネント。
- ソナー：反応のための意見のトーストコンポーネント。
- Tiptap/Core：高度にカスタマイズ可能で拡張可能なリッチテキストエディターフレームワーク。
- SWR：サーバーとのデータフェッチ、キャッシュ、同期を処理します。
- Zustand：小さく、高速でスケーラブルな状態管理ライブラリ。
- Lucide：美しく一貫したアイコン。
プロジェクトの概要
- SRC ：プライマリソースコードディレクトリ。
- SRC/APP ：メインアプリケーションロジックとコンポーネントが含まれています。
- SRC/コンポーネント：再利用可能なUIコンポーネントを家にします。
- SRC/フック：状態および副作用を管理するためのカスタム反応フック。
- SRC/LIB ：ユーティリティ関数とヘルパーモジュール。
- SRC/サービス：外部APIと対話するためのモジュール。
- SRC/スタイル：グローバルスタイルとCSSモジュール。
- SRC/タイプ：タイプスクリプトタイプ定義。
- SRC/UTILS ：その他のユーティリティ関数。
- パブリック：静的資産とビルド出力のパブリックディレクトリ。
セットアップ
openai_api_key
- Openai Webサイトにアクセスしてください。
- アカウントにサインインするか、新しいアカウントを作成します。
- API設定に移動します。
- 秘密の鍵を生成します。
- 生成されたシークレットキーをコピーします。
github_access_token
- Github Webサイトにアクセスしてください。
- アカウントにサインインするか、新しいアカウントを作成します。
- アカウント設定に移動します。
- 「開発者設定」セクションに移動します。
- 必要な権限を使用して、新しい個人アクセストークンを生成します。
kv_rest_api_urlおよびkv_rest_api_token
- Vercel Webサイトにアクセスしてください。
- アカウントにサインインするか、新しいアカウントを作成します。
- ストレージセクションに移動します。
- 新しいKVデータベースを作成します。
- .env.localタブの下からkv_rest_api_urlとkv_rest_api_tokenをコピーします。
Ollama_url
- オラマをダウンロードして実行してください。
- OllamaのインスタンスがデフォルトのIPアドレスとポートで実行されていない場合、.env.exampleファイルの変数を使用してUSECaseに適合します
ローカルで実行します
1.EasyReadMeリポジトリをクローン：
git clone https://github.com/xavimondev/easyreadme
.env.example to .envをnelaname：
3.インストール依存関係：
# bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install
6.開発モードを開始します。
# bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev
重要
NPMパッケージ用のテンプレートを持っているにもかかわらず、まだ多くの作業を行う必要があり、パッケージから正しいタイプを取得する方法について調査しています。
ロードマップ
謝辞
- Sparklesアニメーションは、Josh W. Comeauによって作成されたこの素晴らしいリソースから取られました
- 「コピーコード」ボタンの周りの紙吹雪は、リファレンスとしてLucide Webを使用して作成されました。
ライセンス
このプロジェクトは、 MITライセンスに基づいてライセンスされています。詳細については、 MITライセンスファイルを参照してください。
