amirdianov / django-test-notes-project

WEB project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

django-notes-project

Описание проекта

Микросервис заметок! Что может быть лучше? В данном веб приложении вы сможете оставлять свои заметки, ставить напоминания, оставлять комментарии к чужым заметкам, а также получать уведомления по почте, если кто - то промеокментировал вашу. Также у данного сервиса есть API, которым в случае чего вы тоже можете воспользоваться.

Техническое описание проекта и требования

  1. Python версии не ниже 3.8
  2. Poetry

Инструкции по запуску

  • docker-compose up -d - поднять PostgreSQL с помощью Docker
  • poetry shell - вход в виртуальное окружение
  • poetry install - установка зависимостей
  • python src/manage.py migrate - выполнить миграции
  • python src/manage.py runserver - запуск сервера для разработки на http://localhost:8000
  • pre-commit install - установить pre commit hook
  • pre-commit run -a - запуск линтеров вручную
  • pytest - запустить автоматические тесты

Обозначения символов в коммитах

  • + - добавлено
  • - - удалено
  • = - изменено
  • ! - исправлено
  • x% - сделано на x процентов

Для того, чтобы узнать расположение интерпретатора для настройки в PyCharm, можно выполнить команду poetry env info -p.

Запуск фронтенда

  • cd src/web/static/web/notes-frontend - перейти в папку фронтенда
  • npm ci - установить зависимости
  • npm run watch - сборка для разработки
  • npm run build - сборка для продакшена

About

WEB project


Languages

Language:Python 54.4%Language:Vue 18.7%Language:HTML 16.7%Language:JavaScript 8.1%Language:CSS 1.3%Language:Dockerfile 0.8%Language:Shell 0.0%