ITRadio/README.md

55 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# IT-Рadio
IT-Радио — радиостанция про сферу технологийи развитие в IT
***
[![Flexites](https://img.shields.io/badge/Flexites-white)](https://flexites.org/)
[![AzuraCast](https://img.shields.io/badge/AzuraCast-blue)](https://www.azuracast.com/)
[![Python](https://img.shields.io/badge/Python-ffd429?logo=Python&logoSize=3)](https://www.python.org/)
[![Quasar](https://img.shields.io/badge/Quasar-87cefa?logo=Quasar&logoSize=3)](https://quasar.dev/)
[![DRF](https://img.shields.io/badge/Django_REST_Framework-red)](https://www.django-rest-framework.org/)
[![Nginx](https://img.shields.io/badge/Nginx-green?logo=Nginx)](https://nginx.org/ru/)
[![Gunicorn](https://img.shields.io/badge/Gunicorn-white?logo=Gunicorn)](https://gunicorn.org/)
[![IT-Radio-Logo](docs/logo-it-radio.jpg)](https://itradio.team)
## Установка
У вас должны быть установлены [зависимости проекта](https://git.flexites.org/Students/ITRadio/src/branch/master/server/requirements.txt)
1. Клонирование репозитория
```git clone https://git.flexites.org/Students/ITRadio.git```
2. Переход в директорию ITRadio
```cd ITRadio```
3. Создание виртуального окружения
```python -m venv venv```
4. Активация виртуального окружения
```cd venv/```
```scripts/activate```
5. Установка зависимостей
```cd server/```
```pip install -r requirements.txt```
<!--Пользовательская документация-->
## Документация
Пользовательскую документацию можно получить по [этой ссылке](./docs/ru/index.md).
<!--Поддержка-->
<!-- ## Поддержка
Если у вас возникли сложности или вопросы по использованию сайта напишите на электронную почту <bro.alexeev@inbox.com> -->
<!--Пользовательская документация-->
## Инструкция для работы в панели администратора
Инструкцию можно получить по [этой ссылке](./docs/ru/instruk.md).
<!--Документация для разработчиков-->
## Документация для разработчиков
Проект развёрнут с помощью Gunicorn и Nginx. API документация находится по [адресу](https://itradio.team/api/). Там же и описаны все контроллеры (views), используемые в проекте