Blog Students BUT

Features

Core Functionality

• User Authentication: Register, login and manage user profiles
• Blog Posts: Create, edit, view and delete blog posts
• Categories: Organize posts by categories
• Comments: Interactive commenting system on blog posts
• Messaging System: Private messaging between users with reply functionality
• Responsive Design: Mobile-friendly interface
• Search: Advanced search through blog posts and users

Advanced Features

• PDF Generation: Generate PDF versions of blog posts
• Automated Documentation: Sphinx integration for code documentation
• Admin Features: Comprehensive Django admin interface
• Google Maps Integration: Interactive maps
• Post Privacy: Option to make posts private or password-protected

Requirements

• Python 3.8+
• Django 4.0+
• Additional packages in requirements.txt

Installation

1. Clone the repository:

   git clone https://github.com/Akineyshen/BlogStudentsBUT.git

2. Navigate to the project directory:

    cd BlogStudentsBUT

3. Create virtual environment:

   python -m venv .venv

4. Install dependencies:

   pip install -r requirements.txt

5. Apply migrations:

   python manage.py migrate

6. Create a superuser:

   python manage.py createsuperuser

7. Run development server:

   python manage.py runserver

Project Structure

   BlogStudentsBUT/
   ├── BlogStudentsBUT           # Main blog application
   ├── articles/                 # Blog articles
   ├── docs/                     # Documentation sources
   ├── media/                    # Media Files
   ├── source/                   # Source files
   ├── static/                   # Static files
   ├── templates/                # HTML templates
   ├── users/                    # User application
   ├── .gitignore                # Ignored files
   ├── db.sqlite3                # SQLite database
   ├── manage.py                 # Django management
   ├── README.md                 # Project description
   └── requirements.txt          # Python Dependencies

Building Documentation

1. Install Sphinx:

   pip install sphinx sphinx_book_theme

2. Generate documentation:

   sphinx-build -b html source build/html

3. Open the generated documentation in a web browser:

    open build/html/index.html

Screenshots