？概述
EasyReadMe是一個通過使用預設計的模板和AI生成視覺令人驚嘆的閱讀符，簡化了RECTME創建的項目。它支持為JavaScript/Tystecript，Rust，Java，GO，PHP和Python Projects生成重新記錄。它依賴於廣泛的技術和庫，包括React，Tailwind CSS，Tiptap，OpenAI等。
？目錄
❤️功能
堆
項目摘要
設定
本地運行
？️路線圖
致謝
？執照
特徵
簡介。mp4
模板列表
模板.mp4
自定義讀數
customize.mp4
AI部分
ai-sions.mp4
內聯命令
commands.mp4
氣泡菜單
泡沫 - 菜單。mp4
可編輯的橫幅圖像URL
update-banner.mp4
免費的AI積分，自定義API鍵，本地運行
api-offline-generations.mp4
堆
- 下一步：用於構建服務器渲染的React應用程序的框架。
- React：用於構建用戶界面的JavaScript庫。
- 打字稿：鍵入的JavaScript的超級集，該javaScript編譯為普通的JavaScript。
- SHADCN/UI：為UI提供設計精美的組件。
- TailWindCSS：快速UI開發的公用事業第一CSS框架。
- vaul：一個未風格的抽屜組件。
- Sonner：反應的有用的吐司組件。
- tiptap/core：高度可自定義且可擴展的豐富文本編輯器框架。
- SWR：處理與服務器的數據獲取，緩存和同步。
- Zustand：一個小型，快速且可擴展的狀態管理庫。
- Lucide：美麗且一致的圖標。
項目摘要
- SRC ：主源代碼目錄。
- SRC/APP ：包含主要的應用程序邏輯和組件。
- SRC/組件：容納可重複使用的UI組件。
- SRC/鉤子：用於管理狀態和副作用的自定義React掛鉤。
- SRC/LIB ：實用程序功能和輔助模塊。
- SRC/服務：用於與外部API交互的模塊。
- SRC/樣式：全球樣式和CSS模塊。
- SRC/類型：打字稿類型定義。
- SRC/UTILS ：其他實用程序功能。
- 公共：用於靜態資產的公共目錄和建立產出。
設定
OpenAI_API_KEY
- 轉到OpenAI網站。
- 登錄到您的帳戶或創建一個新帳戶。
- 導航到您的API設置。
- 生成一個秘密鑰匙。
- 複製生成的秘密密鑰。
github_access_token
- 訪問GitHub網站。
- 登錄到您的帳戶或創建一個新帳戶。
- 導航到您的帳戶設置。
- 轉到“開發人員設置”部分。
- 具有必要的權限生成新的個人訪問令牌。
kv_rest_api_url和kv_rest_api_token
- 轉到Vercel網站。
- 登錄到您的帳戶或創建一個新帳戶。
- 導航到存儲部分。
- 創建一個新的KV數據庫。
- 從.env.local選項卡下方復制kv_rest_api_url和kv_rest_api_token。
Ollama_url
- 下載Ollama並運行。
- 如果您的Ollama實例不在默認IP地址和端口上運行，請更改.env.env.example文件中的變量以適合您
本地運行
1.Clone easyreadme存儲庫：
git clone https://github.com/xavimondev/easyreadme
2.將.env.example命名為.env ：
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軟件包的模板，但仍有很多工作要做，並研究如何從軟件包中獲取正確的類型。
路線圖
致謝
- 閃閃發光的動畫取自喬什·W·科莫（Josh W. Comeau）創造的這一巨大資源
- 圍繞“複製代碼”按鈕的五彩紙屑是使用Lucide Web作為參考創建的。
執照
該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見MIT許可證文件。
