Быстрый старт
Необходимо установить Python (рекомендуется 3.8
), Pipenv, Docker и cookiecutter. Подробнее смотрите в разделе Установка зависимостей.
Далее создаем новый проект или запускаем существующий. Перейдите по ссылкам для подробной документации.
Если подробная документация не требуется, то можете использовать команды ниже.
Новый проект
cookiecutter https://github.com/garpixcms/garpixcms-empty-template
cd website
cp example.env .env
pipenv install
pipenv shell
docker-compose up -d
python3 backend/manage.py makemigrations
python3 backend/manage.py migrate
python3 backend/manage.py createsuperuser
python3 backend/manage.py runserver
Запускаем существующий проект
git clone <repo_url>
cd <directory>
cp example.env .env
pipenv install
pipenv shell
docker-compose up -d
python3 backend/manage.py migrate
python3 backend/manage.py createsuperuser
python3 backend/manage.py runserver
Garpix user
Начиная с версии 4.0.0 garpix_auth
заменен на garpix_user
.
Если вы использовали garpix_auth
на проекте с более младшей версией cms, для корректного обновления следуйте инструкциям ниже.
- Установите новую версию модуля
pipenv install garpixcms==4.0.0
. - Следуя инструкциям по установке
garpix_user
(https://github.com/garpixcms/garpix_user#quickstart), настройте проект (обратите внимание, что роуты и базовые настройки уже включены в модуль garpixcms в файлахgarpixcms/settings.py
иgarpixcms/urls.py
соответственно). - После применения миграций выполните команду
python3 manage.py update_user_module
. - Установите переменную окружения
ENABLE_GARPIX_AUTH
в False или просто удалите ее.