Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 8.31 KB

README.md

File metadata and controls

100 lines (69 loc) · 8.31 KB

Каталогизатор ссылок на веб-ресурсы «Simple Catalog»

Веб-ориентированное приложение для составления, поддержания и публикации каталога ссылок на веб-ресурсы, к которым разрешён доступ из локальной сети вуза.

Build Status

Особенности:

  • Интерфейс для заполнения каталога;
  • Автоматическое построение каталога по сферам знаний и дисциплинам;
  • Автоматическое построение списка доменных имён;
  • Поддержка международных доменных имён IDN и корректное кодирование интернет-адресов;
  • Экспорт каталога и списка доменных имён в форматы XML и JSON;
  • Выгрузка списка доменных имён в формат, поддерживаемый прокси-сервером Squid.

Установка

Рекомендуемый тип установки: установка на сервер или рабочую станцию с GNU/Linux, с использованием RVM из под непривилегированного пользователя.

Установка интерпретатора Ruby

bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer ) # Установка RVM
source ~/.bashrc # перезагрузка оболочки для функционирования RVM
rvm requirements # Эта команда выведет пакеты, которые вам нужно будет установить
# Установите то, о чём вас попросили в предыдущей команде!
rvm install 1.9.3  # Установка интерпретатора языка ruby, версии 1.9.3
rvm --default use 1.9.3 # Использовать этот интерпретатор по умолчанию для текущего пользователя
gem install bundler # Установка менеджера зависимостей

Установка зависимостей

Для работы с международными доменными именами (IDN) требуется наличие библиотеки GNU IDN.

Установить её можно следующей командой (в Ubuntu GNU/Linux 12.04)

sudo apt-get install libidn11 libidn11-dev

Установка приложения

cd /path/to/working/directory
git clone [email protected]:AmurSU/simple_catalog.git # Получение актуального исходного кода
cd simple_catalog
bundle install # Установка всех зависимостей приложения

Настройка

cp config/database.yml.sample config/database.yml

Отредактируйте файл config/database.yml для вашей базы данных.

Завершение установки

rake db:setup # Создание базы данных и её заполнение стандартными значениями

Теперь можно запустить приложение локально при помощи команды rails server.

Развёртывание

Для развёртывания приложения используется capistrano. Как развёртывать данное приложение.

Помощь в разработке

Если вы хотите помочь проекту:

  1. Сделайте форк проекта в своём github-аккаунте.
  2. Создайте отдельную ветвь разработки.
  3. Внесите в неё желаемые изменения.
  4. Создайте pull-request из вашей ветви в ветвь master данного репозитария.

Подробнее об этой модели разработки вы можете прочесть в данной статье.

Лицензирование

Данное программное обеспечение распространяется на условиях лицензии MIT:

Copyright © 2012 Амурский государственный университет

Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, добавление, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, также как и лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:

Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.

ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ ТРЕБОВАНИЙ ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ, ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.

С оригинальным текстом лицензии вы можете ознакомиться на сайте opensource.org.