makeread.me скачать - makeread.me исходный код скачать

makeread.me

Данные веб-сайта

1.0.0

Скачать

Makeread.me

Потрясающий генератор Readme, чтобы запустить ваши проекты!

Изучите документы »

Посмотреть демо. Сообщить об ошибке. Функция запроса

О проекте

Скриншот

Одна из проблем, связанных с построением и участием в программном обеспечении с открытым исходным кодом, заключается в том, что, хотя многие проекты имеют удивительные функциональные возможности, они часто упускают в виду более широкую аудиторию из-за отсутствия четких и удобных инструкций по установке. Кроме того, отсутствие эффективной демонстрации их вариантов использования также способствует более низкой охвате этих проектов.

Хотя есть шаблоны Readme, которые могут помочь решить эту проблему, процесс заполнения вручную этих шаблонов может быть трудоемким и утомительным. Вот где входит наш проект Makeread.me.

Представляем Makeread.me, автоматизированный генератор Readme, который может революционизировать, как вы создаете документацию по проекту. Он предназначен для:

Сэкономьте ценное время, улучшив ваше внимание на разработке,
Автоматизировать избыточные задачи и,
Реализуйте сухие (не повторяйте себя) принципы к вашей документации.

Это бесплатно, с открытым исходным кодом и очень настраиваемый. Не стесняйтесь изменять наши шаблоны, чтобы соответствовать вашим потребностям. Если вы обнаружите, что конкретный компонент отсутствует, вы можете внести свой вклад и расширить проект.

Мы позволили вам внести свой вклад в проект, используя шаблоны Nunjucks и JSON для программного картирования. Наслаждайтесь преимуществами четкой и краткой проектной документации с MakereAd.me!

Построен с

Этот проект был построен со следующими технологиями:

Next.js
Реагировать
Shadcn/ui
Реагировать форму крючка
Машинопись
Выражать

Начиная

Это пример того, как вы можете дать инструкции по настройке своего проекта на месте. Чтобы получить локальную копию и запуск, следуйте этим простым примерам.

Предварительные условия

Этот проект требует, чтобы пряжа была установлена в вашей системе. Если у вас нет установки, вы можете выполнить эти шаги:

Установите прядь глобально, используя NPM (Manager Package Node). Откройте свой терминал и запустите:
```
npm install -g yarn
```
Пожалуйста, убедитесь, что у вас установлены Node.js и NPM перед запуском пряжи.
Убедитесь, что пряжа была установлена на вашем компьютере, запустив следующую команду в вашем терминале:
```
yarn --version
```
Если пряжа была установлена правильно, ваш терминал должен отображать версию пряжи, установленную на вашей машине.

Теперь вы готовы использовать пряжу для управления и обозначения вашего проекта зависимостей!

Установка

Пожалуйста, выполните следующие шаги для успешной установки:

Клонировать репозиторий: Начните с клонирования репозитория на местную машину.
```
 https://github.com/ShaanCoding/makeread.me
```
Установите пакеты Frontend: перейдите к каталогу «/Frontend» и установите необходимые пакеты пряжи, выполнив следующую команду в вашем терминале:
```
yarn install
```
Установите бэкэнд -пакеты: аналогично, перейдите к каталогу «/Backend» и установите необходимые пакеты пряжи, выполнив следующую команду в вашем терминале:
```
yarn install
```
Установите среду:
- В каталоге "/Backend" скопируйте содержимое файла .env.example "и создайте новый файл с именем" .env ". Отрегулируйте переменные среды в соответствии с вашими требованиями, или вы можете оставить их такими, какие они есть.
- Перейдите к «Frontend/API/сгенерировано/readmegenerator.ts» и установите базовый параметр на свой бэкэнд -маршрут API. Например, если вы используете Backend на своем локальном сервере на порте 8080, вам следует установить:
```
BASE: "http://localhost:8080/api" ;
```
Запустите Backend: перейдите к каталогу «/Backend» и введите следующую команду в вашем терминале, чтобы запустить сервер бэкэнд:
```
yarn dev
```
Запустите Frontend: Наконец, перейдите к каталогу «/Frontend» и введите следующую команду в вашем терминале, чтобы запустить ваш фронтальный сервер:
```
yarn dev
```
Теперь ваше приложение должно быть успешно запустить и запустить!

Дорожная карта

Дорожная карта включает в себя как завершенные, так и будущие цели. Вот что мы достигли и с нетерпением ждем:

Мы продолжаем наше приверженность улучшению и расширению возможностей MakereAd.me для обеспечения эффективного и бесшовного опыта генерации Readme для наших пользователей.

Смотрите открытые проблемы для полного списка предлагаемых функций (и известных проблем).

Внося

Вклад - это то, что делает сообщество с открытым исходным кодом таким удивительным местом для изучения, вдохновения и создания. Любой вклад, которые вы вносите, высоко ценится .

Если у вас есть предложение, которое сделает это лучше, пожалуйста, разделите репо и создайте запрос на тягу. Вы также можете просто открыть проблему с тегом «Улучшение». Не забудьте дать проекту звезду! Еще раз спасибо!