ReadMeAI

？ redmeai？

概述

README生成器是一个平台，允许用户上传单文件代码并描述其项目。 AI生成了降价代码，该代码可以使用代码编辑器实时编辑，并立即预览更改。

readmeai现在住在readmeai.live

导航

• ？ redmeai？
  • 概述
  • 导航
  • ？特征
  • 文件结构（MVC）
  • 技术堆栈
  • 安装
    • 在您当地的机器中
    • 在您的虚拟机（使用Docker）中
  • 用法
    • 在您当地的机器中
    • 使用Docker容器
  • ？下一个版本的功能。
  • ？支持
  • ✍️作者

？特征

• AI驱动的内容：它使用Google AI为您的读书人生成有意义且有用的内容，包括项目描述，使用情况，安装等。

• 自定义：您可以使用内置编辑器自定义生成的内容以包含或排除特定部分，以确保您的阅读文件反映您的项目的独特需求。

• 降价支持：生成的读数文件使用Markdown，使您可以易于格式化和样式的项目文档。

• 用户友好的Web界面：通过用户友好的Web界面访问生成器，从而消除了对手动设置的需求。

文件结构（MVC）

• ？ API/ ：包含连接到第三方API的代码文件（Google Palm 2）
• ？控制器/ ：包含所有业务逻辑以在邮政/获取请求上执行的所有业务逻辑。
• ？视图/ ：包含在客户端渲染的文件。
• ？数据/ ：包含将保存输出模板和“输出”的“模板”，该模板将输出降低。
• ？公共/ ：包含客户端CS和脚本。
• ？路由/ ：文件以处理路由并在特定路线上调用相应的控制器功能。
• ？上传/ ：此目录将保存服务器从客户端接收到的文件，然后在会话结束后删除它们。
• ？ server.js ：此文件是主要的Express服务器，这是将在启动服务器上执行的文件。
• ？ Dockerfile ：此文件包含用于容器化项目的脚本。

技术堆栈

• node.js：服务器端运行时。
• express：node.js框架。
• ？ Google Palm API：Google Pathways语言模型是基于5400亿个参数变压器的大语言模型。
• ？ 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控制台中的CRBBUG错误，请按照以下步骤操作。

1. 在左侧栏中打开Vscode访问“运行和调试”菜单。
2. 单击“创建启动”文件”，然后在弹出菜单中选择node.js。
3. 现在，单击同一“ Run and Debug”侧边栏上顶部的Green Triangular Play图标。
4. 现在访问http：// localhost：3333

？下一个版本的功能。

• GitHub授权添加回购而不是单个文件。
• 训练有素的AI可以为文件夹而不是文件生成读数。
• 自定义模板，用户可以定义他们想要的功能/部分。

？支持

如果您遇到任何问题或有疑问，请随时在存储库上创建问题。我们在这里为您提供帮助！

✍️作者

• Gitanshu Sankhla（后端开发人员） -

• Vijay Banjara（前端开发人员） -
  

• 苛刻的库马尔（设计师） -