Skip to content

DevvIlya/blog

Repository files navigation

Blog Project

Этот проект — это простой блог на базе Django, настроенный с использованием Docker, PostgreSQL и Tailwind CSS для стилизации. В проекте используется файл с переменными окружения для безопасной настройки.

Установка и настройка

  1. Клонируйте репозиторий:

    git clone https://github.com/DevvIlya/blog.git
    cd blog
  2. Создайте файл .env:

    Создайте файл .env в корне проекта на основе шаблона .env.template, который прилагается:

    cp .env.template .env

    Откройте .env и замените значения по умолчанию на свои настоящие данные.

    Django требует уникального секретного ключа. Вы можете сгенерировать его с помощью Python:

    python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"
  3. Создайте файл .config.py: Создайте файл .config.py в корне проекта на основе шаблона .config.py.template, который прилагается:

    cp .config.py.template .config.py

    Откройте .config.py и замените значения по умолчанию на свои настоящие данные.

  4. Соберите и запустите проект:

    Построите и запустите контейнеры Docker с помощью команды:

    docker-compose up --build

Запуск проекта

После настройки проекта вы можете получить доступ к приложению по следующим адресам:

  • Веб-приложение: http://localhost:8000
  • Админка Django: http://localhost:8000/admin
  • API: http://localhost:8000/api/

Docker команды

  • Чтобы остановить контейнеры:

    docker-compose down
  • Чтобы пересобрать контейнеры:

    docker-compose up --build

API

В проекте реализован REST API с помощью Django REST Framework.

Базовый адрес API

http://localhost:8000/api/

Доступные эндпоинты

Метод Адрес Описание
GET /api/posts/ Получить список всех постов
POST /api/posts/ Создать новый пост
GET /api/posts/<id>/ Получить информацию о конкретном посте
PUT /api/posts/<id>/ Обновить пост
DELETE /api/posts/<id>/ Удалить пост
GET /api/comments/ Получить список всех комментариев
POST /api/comments/ Добавить комментарий
GET /api/comments/<id>/ Получить информацию о комментарии
PUT /api/comments/<id>/ Обновить комментарий
DELETE /api/comments/<id>/ Удалить комментарий

Использование

Проект настроен на использование Docker и Docker Compose, которые автоматически соберут контейнеры для веб-приложения и базы данных. После настройки вы можете запускать и останавливать приложение с помощью указанных команд Docker.

Для разработки используется Django для создания веб-приложения и Django REST Framework для реализации API. Также применен Tailwind CSS для стилизации.


Удачи в разработке!

About

A minimal blog engine

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors