ROLOBOOK / PhoneBookAPI

Проект PhoneBookAPI API телефонный справочник организаций.
Справочник представляет собой API приложение(DFR) для поиска номеров телефонов и информации об организациях.

Информация, хранимая об организации: адрес, название, описание и список сотрудников.
Информация, хранимая о сотрудниках: ФИО, должность и номера телефонов.
Номера телефонов могут быть различных типов: Рабочий, Личный, Факс

На главной странице api/v1/ выводится список организаций.
Поиск представляет собой API вида /search?q=. Поиск осуществялется по названию организации, сотрудникам и номерам телефонов.
Автодокументация доступна по адресу swagger/

В разработке

• Авторизация
• Аутентификация

Команды для запуска приложения

• Клонировать репозиторий и перейти в него в командной строке
• Перейти в клонированый репозиторий
• Запуск приложения в докере
  • собрать образ

  docker build . -t phonebook
  

  • запустить образ

  docker run -it -p 8000:8000 phonebook
  

  • выполнить миграцию

  docker exec -it <CONTAINER ID> python manage.py migrate
  

  • создать администратора

  docker exec -it <CONTAINER ID> python manage.py createsuperuser
  

• Запуск приложения через терминал (linux)
  • создать и авктивировать виртуальное окружение

  python -m venv venv
  

  . venv/bin/activate
  

  • установить зависимости

  pip install -r requirements.txt
  

  • запусить приложение

  python manage.py runserver
  

  • выполнить миграцию

  python manage.py migrate
  

  • создать администратора

  python manage.py createsuperuser