? ReadMeai?
Обзор
Генератор README-это платформа, которая позволяет пользователям загружать код с одним файлом и описывать свой проект. ИИ генерирует код разметки, который может быть отредактирован в режиме реального времени с использованием редактора кода, и изменения мгновенно просмотрены.
ReadMeai сейчас живет на readmeai.live
Навигация
- ? ReadMeai?
- Обзор
- Навигация
- ? Функции
- Структура файла (MVC)
- Технический стек
- Установка
- В вашей местной машине
- В вашей виртуальной машине (с помощью Docker)
- Использование
- В вашей местной машине
- Использование контейнера Docker
- ? Особенности для следующего релиза.
- ?Поддерживать
- ✍ авторы
? Функции
Контент с AI : он использует Google AI для создания значимого и информативного контента для вашего чтения, включая описание проекта, использование, установку и многое другое.
Настройка : Вы можете настроить сгенерированный контент, используя встроенный редактор для включения или исключения конкретных разделов, обеспечивая, чтобы ваш Readme отражал уникальные потребности вашего проекта.
Поддержка Markdown : сгенерированные файлы README используют Markdown, что позволяет легко форматировать и стилеть документацию по проекту.
Веб-интерфейс, удобный для пользователя : доступ к генератору через удобный веб-интерфейс, устраняя необходимость ручной настройки.
Структура файла (MVC)
- ? API/ : содержит файл кода для подключения к API третьей стороны (Google Palm 2)
- ? Controllers/ : содержит всю бизнес -логику для выполнения по запросам post/ get.
- ? Views/ : содержит файлы для рендеринга на стороне клиента.
- ? Data/ : содержит «шаблон» , который будет удерживать выходной шаблон и «output.md» , который выведет наметку.
- ? Public/ : содержит клиентские CSS и сценарии.
- ? Маршруты/ : Файл для обработки маршрутов и для вызова соответствующей функции контроллера по конкретному маршруту.
- ? Загружает/ : В этом каталоге будут храниться файлы, полученные со стороны клиента, а затем удаляет их после завершения сеанса.
- ? Server.js : Этот файл является основным сервером Express , это файл, который будет выполняться на начальном сервере.
- ? Dockerfile : Этот файл содержит скрипт для проекта Containerize.
Технический стек
- Node.js: время выполнения на стороне сервера.
- Express: Node.js Framework.
- ? Google Palm API: Google Pathways Language Model представляет собой крупную языковую модель на основе 540 миллиардов параметров.
- ? EJS: шаблон двигателя для рендеринга и добавления динамического контента в HTML на сервере.
- ? CSS: стиль шаблона HTML.
- JavaScript: чтобы добавить интерактивность в фронт.
Установка
В вашей местной машине
- Клонировать репозиторий.
- Перейдите к каталогу проекта.
- Откройте свой терминал и запустите:
В вашей виртуальной машине (с помощью Docker)
- Клонировать репо и перейти к каталогу проекта.
- Откройте терминал и введите следующую команду:
docker build -t gitax18/readmeai .
Использование
В вашей местной машине
- Изменение в каталоге проекта.
- Откройте свой терминал и введите следующую команду:
- Приложение будет работать на http: // localhost: 3333
Использование контейнера Docker
- Чтобы запустить контейнер, введите следующую команду:
docker run -it -p 3333:3333 gitax18/readmeai
- Теперь приложение будет работать на http: // localhost: 3333
Примечание. Если проект не работает должным образом, и покажите ошибку CRBUG в веб -консоли, затем выполните следующие шаги.
- Откройте VSCODE A a go to 'Run and Devog' Menu на левой боковой панели.
- Нажмите «Создать файл a a wairst.json» и выберите Node.js в всплывающем меню.
- Теперь нажмите на значок зеленого треугольного воспроизведения на боковой панели «Запуск и отладка».
- Теперь перейдите по адресу http: // localhost: 3333
? Особенности для следующего релиза.
- Github разрешение на добавление репо, а не отдельного файла.
- Более обученный ИИ для генерации readme для папок, а не для файла.
- Пользовательские шаблоны, пользователь может определить, какие функции/раздел они хотят в своем чтении.
?Поддерживать
Если вы сталкиваетесь с какими -либо проблемами или у вас есть вопросы, пожалуйста, не стесняйтесь создавать проблему в репозитории. Мы здесь, чтобы помочь!
✍ авторы
