JSON API доступа к почтовым индексам Почты России

Небольшое веб-приложение, предоставляющее доступ к официальной базе почтовых индексов ФГУП «Почта России» в формате JSON.

Написано на языке программирования Ruby с использованием программного каркаса Sinatra.

URL: http://postindexapi.ru

Разработка

Для разработки вам потребуется POSIX-совместимая ОС (желательно Linux или Mac OS X), СУБД PostgreSQL, интерпретатор Ruby (рекомендуется устанавливать через RVM) и текстовый редактор (попробуйте Sublime Text).

Склонируйте исходный код: git clone git://git@github.com:Envek/postindexapi.ru и перейдите в папку с исходным кодом;
Установите требуемые зависимости: bundle install;
Скопируйте файлы config/*.yml.sample в config/*.yml и отредактируйте под себя;
Создайте учётную запись в PostgreSQL;
Разверните бэкап БД или установите новую: rake db:schema:load;
Скачайте актуальную базу почтовых индексов: rake post_index:update
Работайте!

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

Буду рад любой помощи и дополнениям!

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

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

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

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

Для развёртывания системы используется Capistrano.

Первое развёртывание

cap deploy:setup
cap deploy:update
# Отредактируйте settings.yml и database.yml, создайте пользователя и БД
cap deploy

Повторные развёртывания

cap deploy

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

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

Copyright © 2013 Новиков Андрей Александрович

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

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

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

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

mibamur / postindexapi.ru