? Обзор
EasyReadMe-это проект, который упрощает создание ReadMe, генерируя визуально потрясающие чтения, используя предварительно разработанные шаблоны и ИИ. Он поддерживает генерацию чтения для проектов JavaScript/TypeScript, Rust, Java, GO, PHP и Python. Он опирается на широкий спектр технологий и библиотек, включая React, Taillid CSS, TiptAP, OpenAI и многое другое.
? Оглавление
❤ Особенности
Куча
Резюме проекта
Настройка
Бежать локально
? ️ дорожная карта
Благодарности
? Лицензия
Функции
ВВЕДЕНИЕ.mp4
Список шаблонов
шаблоны.mp4
Настроить readme
настраивать.mp4
Секции ИИ
ai-sections.mp4
Встроенные команды
commands.mp4
Пузырьковое меню
Bubble-Menu.mp4
Redake Banner Image URL
Update-banner.mp4
Бесплатные кредиты AI, пользовательский ключ API, локальный запуск
API-Offline-Generations.mp4
Куча
- Далее: структура для построения серверных приложений React.
- React: библиотека JavaScript для создания пользовательских интерфейсов.
- TypeScript: напечатанный суперсет JavaScript, который компилируется для простого JavaScript.
- Shadcn/UI: предоставляет красиво разработанные компоненты для пользовательского интерфейса.
- Tailwindcss: первая коммунальная структура CSS для быстрой разработки пользовательского интерфейса.
- Vaul: нестабильный компонент ящика для React.
- Sonner: самоуверенный тост -компонент для React.
- TiptAp/Core: очень настраиваемый и расширяемый платформ богатый текстовый редактор.
- SWR: обрабатывает извлечение данных, кэширование и синхронизация данных с сервером.
- Zustand: небольшая, быстро и масштабируемая библиотека управления государством.
- Люцид: красивые и последовательные иконы.
Резюме проекта
- SRC : каталог основного исходного кода.
- SRC/APP : содержит основную логику приложения и компоненты.
- SRC/Компоненты : Дома многоразовые компоненты пользовательского интерфейса.
- SRC/Hooks : пользовательские крючки 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.
- Скопируйте KV_REST_API_URL и KV_REST_API_TOKEN из -под вкладки .env.local .
Ollama_url
- Скачать Ollama и запустить его.
- Если ваш экземпляр Ollama не работает на IP-Address и Port по умолчанию, измените переменную в файле .env.example, чтобы соответствовать вашему usecase
Бежать локально
1.clone Repository easyReadMe:
git clone https://github.com/xavimondev/easyreadme
2. Rename the .env.example to .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, предстоит еще много работы, и исследовать, как получить правильные типы из пакетов.
Дорожная карта
Благодарности
- Анимация Sparkles была взята из этого великого ресурса, созданного Джошем У. Комо,
- Конфетти вокруг кнопки «Копировать код» был создан с использованием веб -сайта Lucide в качестве ссылки.
Лицензия
Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии MIT .
