Skip to content

A modern WordPress-based technology news portal with a custom theme

License

Notifications You must be signed in to change notification settings

Samurajsam/neo-feed

Repository files navigation

Neo Feed - Modern Tech News Portal

A modern WordPress-based technology news portal with a custom theme and enhanced features.

🚀 Project Overview

Neo Feed is a fully-featured WordPress installation with a custom-built theme (neotheme) designed for technology news and content publishing. The project features a modern, responsive design with advanced functionality including AJAX comment voting, custom archive layouts, and optimized user experience.

✨ Key Features

  • Custom WordPress Theme - Modern, responsive design built from scratch
  • AJAX Comment Voting - Real-time upvote/downvote system with color-coded scores
  • Dynamic Archive Layouts - Grid view for categories, list view for other archives
  • Categories Overview - Browse all categories at /category/ with thumbnails and post counts
  • Archives Overview - Navigate years and months at /archiwum/ with organized structure
  • Smart Year Archives - Year pages display months instead of posts for better navigation
  • Featured Posts System - Mark posts as featured with custom meta box
  • Latest Posts Page - Dedicated page with grid layout and pagination
  • Responsive 404 Page - Custom error page with adaptive background image
  • SEO Optimized - Semantic HTML5 markup and proper meta tags
  • Dark Mode Design - Modern dark theme with gradient accents
  • Smooth Animations - CSS transitions and hover effects throughout

📋 Requirements

  • PHP: 7.4 or higher
  • WordPress: 5.0 or higher
  • MySQL: 5.6 or higher / MariaDB 10.1 or higher
  • Web Server: Apache or Nginx

🛠️ Installation

Local Development Setup

  1. Clone the repository

    git clone https://github.com/Samurajsam/neo-feed.git
    cd neo-feed
  2. Configure WordPress

    • Copy wp-config-sample.php to wp-config.php
    • Update database credentials in wp-config.php
  3. Import Database

    • Create a new MySQL database
    • Import the database dump (if provided)
  4. Activate Theme

    • Navigate to WordPress admin panel
    • Go to Appearance → Themes
    • Activate the neotheme theme
  5. Configure Permalinks

    • Go to Settings → Permalinks
    • Select "Post name" structure
    • Save changes
  6. Create Latest Posts Page

    • Create a new page with slug latest
    • Assign the "Latest Posts" template
  7. Access Special Pages

    • Categories overview: /category/
    • Archives overview: /archiwum/
    • These pages are automatically available (no page creation needed)

📁 Project Structure

neo-feed/
├── wp-admin/                  # WordPress admin files
├── wp-includes/               # WordPress core files
├── wp-content/
│   ├── themes/
│   │   └── neotheme/         # Custom theme
│   │       ├── style.css
│   │       ├── functions.php
│   │       ├── header.php
│   │       ├── footer.php
│   │       ├── front-page.php
│   │       ├── index.php
│   │       ├── single.php
│   │       ├── page.php
│   │       ├── archive.php
│   │       ├── page-latest.php
│   │       ├── page-categories.php    # Categories overview
│   │       ├── page-archives.php      # Archives overview
│   │       ├── comments.php
│   │       ├── sidebar.php
│   │       ├── 404.php
│   │       ├── assets/
│   │       │   ├── js/
│   │       │   │   └── comments.js
│   │       │   └── images/
│   │       │       └── 404-error.png
│   │       └── README.md
│   ├── plugins/              # WordPress plugins
│   └── uploads/              # Media uploads
├── .gitignore
└── README.md                 # This file

🎨 Theme Features

The neotheme custom theme includes:

  • Modern portal-style homepage with featured posts
  • Category-based content sections
  • Grid and list archive layouts
  • Categories overview page (/category/) - Browse all categories with thumbnails
  • Archives overview page (/archiwum/) - Navigate years and months hierarchically
  • Smart year archives - Years display months instead of posts
  • Featured posts system with custom meta box
  • AJAX-powered comment voting system
  • Responsive navigation with sticky header
  • Clickable footer section headers for quick navigation
  • Custom archive title prefixes ("Archiwum:", "Rok:")
  • Custom 404 error page
  • Optimized for performance and SEO

For detailed theme documentation, see wp-content/themes/neotheme/README.md

🔧 Configuration

Menus

Configure navigation menus in Appearance → Menus:

  • Primary Menu - Main site navigation
  • Footer Menu - Footer links

Widgets

Add widgets in Appearance → Widgets:

  • Main Sidebar - Sidebar content for pages

Custom Settings

  • Site Logo: Upload in Appearance → Customize → Site Identity
  • Homepage Settings: Configure in Settings → Reading

🚦 Development

Local Development Server

If using WAMP/XAMPP:

http://localhost/neo-feed/

Git Workflow

The .gitignore file excludes:

  • WordPress core files (managed separately)
  • User uploads (wp-content/uploads/)
  • Language files (wp-content/languages/*.json)
  • Debug logs
  • System files

Only custom theme files and configuration are tracked in version control.

📝 License

  • WordPress Core: GPL v2 or later
  • neotheme Theme: GPL v2 or later
  • Project: GPL v2 or later

👨‍💻 Author

Grzegorz Błażusiak

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📞 Support

For issues and questions:

  • Open an issue on GitHub
  • Check WordPress documentation at wordpress.org

🔄 Changelog

Version 1.1.0

  • Added categories overview page (/category/)
  • Added archives overview page (/archiwum/)
  • Year archives now display months instead of posts
  • Featured posts system with custom meta box
  • Clickable footer section headers
  • Custom archive title prefixes
  • Enhanced archive navigation experience
  • Improved theme structure and organization

Version 1.0.0

  • Initial project setup
  • Custom neotheme theme implementation
  • AJAX comment voting system
  • Custom archive layouts
  • Latest posts page template
  • Responsive 404 page
  • Dark mode design
  • SEO optimization

About

A modern WordPress-based technology news portal with a custom theme

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors