Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2.11 KB

README.md

File metadata and controls

54 lines (41 loc) · 2.11 KB
Raw

Simple blog using Django and Jinja templating

Blog site allows you to create and edit articles. The user can register on the site and create, edit, read, or delete articles. You can categorize articles. Unregistered user can only read articles. Also, you can register as superuser and manage the site with the admin panel. The app is written in Python using Django and Jinja templating.

Features

Feature Supported
Simple blog site ✅
CRUD for articles ✅
Endpoints for filtering articles ✅
Forms for user registration ✅
Tested Python version 3.10
Tested Django version 4.0.4

The app supports operations

Endpoints:

  • GET http://127.0.0.1:8000/ - view home page
  • GET /post/int:post_id/ - view article's detailed information
  • GET /category/int:cat_id/ - filtering articles by category
  • GET /about/ - get about page where you can find information about site
  • POST /add/ - you can add new article (if you sing in)
  • POST /feedback/ - you can write a letter to site admins
  • POST /sign_up/ - registration
  • POST /sign_in/ - sign in
  • POST /logout/ - logout

Tools used during development: black, flake8

Installation

  • You can clone master branch and work with it like with default Django app
  • git@github.com:KyryloKireiev/women_blog_site.git
  • All commands are in the Makefile
  • Django app in master branch using sqlite3 database
  • Detail installation instruction you can found in SETUP.md file

One-clik installation

  • You can also install the application in one click
  • Use "docker-compose-version" branch
  • Use command: make web.install
  • This command creates and runs docker-compose services with Django app and postgres db, then it fills the database with test data and creates superuser to access to Django admin penal.
  • Also, you can see more commands in the makefile
  • Default server starts at http://0.0.0.0:8000/