fillis.ru

fillis.ru — открытый некоммерческий архив Джеймса Филлиса: оригинальные тексты, переводы, сопутствующие материалы.

Цель — сохранить материалы и сделать их доступным для исследователей и практиков.


Собранная и доступная версия портала fillis.ru

Как собрать и запустить проект локально

Требования

У вас должны быть установлены:

  • Node.js ≥ 18
  • npm ≥ 9
  • Git

Установка и запуск

  1. Клонируйте репозиторий
    git clone https://gitverse.ru/fillis/fillis.ru.git
    cd fillis.ru
    
  2. Установите зависимости
    npm install
    
  3. Запустите локальный сервер
    npm run dev
    

После запуска сайт будет доступен по адресу:

http://localhost:8080

Структура проекта

Путь Описание Движок (логика) портала Материалы/наполнение
src/_csstemplates Шаблоны css для tailwindcss X
src/_data Глобальные данные и конфигурация X
src/_includes Шаблоны страниц X
src/assets/css Стили X
src/assets/js JavaScript исполняемый код X
src/assets/books Книги: изображения, метаданные X
src/pages Контент портала X
./README.md Знакомство с проектом X
./CONTRIBUTORS.md Участники сообщества / Контрибьюторы X
./LICENSE.md Лицензия X
./NOTICE.md Правовая информация X
./package.json Конфигурация X
./tailwind.config.js Конфигурация X

Если вы добавляете новые материалы (тексты, переводы), размещайте их в соответствующих подкаталогах, соблюдая существующую структуру.

Как внести изменения

Вклад через Pull Request (PR)

  1. Зарегистрируйтесь или войдите в GitVerse
    Чтобы участвовать в проекте, вам нужна учётная запись на GitVerse.
    Если у вас её нет — зарегистрируйтесь, это займёт пару минут.

  2. Создайте форк репозитория

    1. Откройте страницу проекта https://gitverse.ru/fillis/fillis.ru и нажмите Форк или сразу перейдите на https://gitverse.ru/fillis/fillis.ru/fork
    2. Заполните необходимую информацию и нажмите Форкнуть репозиторий
    3. Это создаст личную копию проекта в вашем профиле, например
      https://gitverse.ru/<ваш_профиль>/fillis.ru
      
  3. Клонируйте свой форк на компьютер

    git clone https://gitverse.ru/<ваш_профиль>/fillis.ru.git
    cd fillis.ru
    
  4. Создайте новую ветку для изменений

    git checkout -b fix/название-изменения
    

    Примеры названий веток:

    • fix/typo-in-foreword
    • add/new-translation-intro
      Разные изменения нужно выполнять в разных ветках
  5. Внесите изменения и проверьте их локально

    1. Откройте проект в редакторе

    2. Внесите нужные правки (текст, перевод, код, стили и т.д.).

    3. Проверьте сайт локально:

      npm install
      npm run dev
      

      После запуска сайт будет доступен по адресу:
      http://localhost:8080

    4. Зафиксируйте изменения и отправьте их в свой форк

      git add .
      git commit -m "Краткое описание изменений"
      git push origin fix/название-изменения
      
    5. Создайте Pull Request (запрос на включение изменений)

      1. Перейдите в свой форк на GitVerse, например https://gitverse.ru/<ваш_профиль>/fillis.ru
      2. Перейдите в Запросы
      3. Нажмите Создать новый запрос
      4. В качестве базового репозитория выберете fillis.ru, ветку мастер
      5. Укажите краткое и понятное описание изменений
      6. Создайте запрос
    6. Ожидайте проверки и обсуждения

      1. Мейнтейнеры проекта рассмотрят ваш PR,
        при необходимости зададут уточняющие вопросы или предложат правки.
      2. После согласования PR будет объединён в основную ветку проекта.
      3. Если это ваш первый вклад — вас добавят в список контрибьюторов (Участники сообщества)
      4. После влития PR изменения автоматически подтянутся на https://fillis.ru

Вклад через задачу

Если вы не готовы править код/контент сами, но хотите предложить идею или сообщить о проблеме:

  1. Откройте вкладку Задачи в репозитории на GitVerse.

  2. Нажмите Добавить задачу

  3. Укажите:

    1. Краткое название (что и где не так).
    2. Описание/шаги воспроизведения (для багов).
    3. Ожидаемое поведение или предполагаемое решение.
    4. Материалы: ссылки, скриншоты, примеры текста, источники.
  4. Нажмите Добавить задачу

  5. Ожидайте реализации и обсуждения

    1. Участники проекта рассмотрят ваш PR,
      при необходимости зададут уточняющие вопросы или предложат правки.
    2. После реализации изменения будут влиты в основную ветку проекта
    3. Если это ваш первый вклад — вас добавят в список контрибьюторов (Участники сообщества)
    4. После влития PR изменения автоматически подтянутся на https://fillis.ru