Skip to content

Latest commit

 

History

History
443 lines (321 loc) · 14.7 KB

README.md

File metadata and controls

443 lines (321 loc) · 14.7 KB
Raw

News Portal

Welcome to the News Portal, a comprehensive and modular news website built with Laravel. This project is designed to offer a wide range of features, providing a robust and flexible platform for managing news content. The application is organized into several modules, each responsible for a specific functionality.

Table of Contents

Features

  • Modular Architecture: Easy maintenance and scalability with separate modules for different functionalities.
  • Comprehensive Article Management: Rich text editor, support for images and videos, categorization, and tagging.
  • User Authentication and Role Management: User registration, login, password reset, email verification, and role-based access control.
  • Advertisement Management: Create and manage ad campaigns, track ad performance, and display ads across the site.
  • Category and Tag Management: Create and manage categories and tags, assign them to articles.
  • Commenting System: User comments with moderation tools, nested comments, Markdown support, and status management (approved, rejected, pending).
  • File Management: Upload, edit, and manage images and videos.
  • Newsletter Management: Subscription form, send newsletters to subscribers, track email campaign performance.
  • Social Network Integration: Share articles on social media, manage user and site social media links.
  • Customizable Settings: Site-wide settings, third-party integrations, cache management, and social network management.
  • SEO Management: Manage meta tags for various pages (articles, authors, categories, tags, homepage, etc.), optimize site for search engines, and track SEO performance.
  • Redirect Management: Create and manage URL redirects to handle outdated or moved content efficiently.
  • Menu Builder: Create and manage different types of menus (main, submenu, category, parent category), add and arrange menu items.
  • Homepage Management: Configurable sections for featured articles, latest news, and more; customizable layout.
  • Detailed Analytics: Track article views, user interactions, and content performance.
  • Administrative Panel: Dashboard with site statistics and management tools for all modules.
  • Hot Content Tracking: Mark articles and tags as "hot" to highlight trending content.
  • Contact Form Management: Manage incoming messages from users through the contact form.
  • User Activity Tracking: Track user interactions, requests, and activities for comprehensive insights into user engagement and site traffic patterns.
  • Page Builder: Create and manage custom pages with ease using a flexible and intuitive interface.

Requirements

  • PHP >= 8.1
  • Composer
  • MySQL
  • Laravel >= 10.x

Installation

  1. Clone the repository:

    git clone https://github.com/1970Mr/news-portal.git
cd news-portal

  2. Install dependencies:

    composer install

  3. Set up environment variables:

    Copy the .env.example file to .env and update the necessary settings, such as database credentials.

    cp .env.example .env

    Add the following initial settings to your .env file:

    APP_NAME="News Portal"
...
ADMIN_FULL_NAME=test
ADMIN_USERNAME=test
ADMIN_EMAIL=test@gmail.com
ADMIN_PASSWORD=password

PANEL_PREFIX=panel

    Configure your database and email server settings in the .env file:

    DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=news_portal
DB_USERNAME=root
DB_PASSWORD=your_password

MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=your_username
MAIL_PASSWORD=your_password
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=hello@example.com
MAIL_FROM_NAME="${APP_NAME}"

  4. Generate application key:

    php artisan key:generate

  5. Run migrations:

    php artisan migrate

  6. Seed the database:

    php artisan db:seed

  7. Create a symbolic link to the storage directory:

    php artisan storage:link

  8. Start the development server:

    php artisan serve

Your application should now be running at http://localhost:8000.

Configuration

The configuration for each module can be found in the respective module's directory. Make sure to review and adjust the configuration files to suit your needs.

Panel URL Prefix

With the PANEL_PREFIX configuration in your .env file, you can easily change the prefix for all admin panel URLs. For example, setting PANEL_PREFIX=admin will change all URLs that start with /panel to /admin. This change will automatically be applied to all administrative modules, ensuring a consistent and customizable URL structure for the admin panel.

For instance:

  • If PANEL_PREFIX=panel, the URL for the admin dashboard might be http://localhost:8000/panel/.
  • If you change PANEL_PREFIX=admin, the URL will change to http://localhost:8000/admin/.

This feature allows for flexibility in URL management, making it easier to integrate the News Portal with existing systems or to adhere to specific organizational URL schemes.

Usage

Once installed, you can start using the News Portal by navigating to the appropriate sections via the web interface. Below are the details of the main modules and their functionalities.

Modules

Article

The Article module manages the creation, editing, and publishing of news articles.

  • Features:
    • Rich text editor for writing articles
    • Support for images and videos
    • Article categorization and tagging
    • Set publication dates for articles
    • Specify the publication status of articles
    • Mark articles as "hot"
    • Feature articles as editor's picks

Category

The Category module manages the categorization of articles.

  • Features:
    • Create and manage categories
    • Assign articles to categories

Tag

The Tag module handles the tagging of articles.

  • Features:
    • Create and manage tags
    • Assign tags to articles

Comment

The Comment module allows users to comment on articles.

  • Features:
    • User comments on articles
    • Moderation tools for comments
    • Nested comments support
    • Comments can be in three statuses: approved, rejected, or pending
    • Review and change the status of comments to approved, rejected, or seen
    • Comments can be submitted in Markdown format

AdManager

The AdManager module handles the creation, management, and display of advertisements across the site.

  • Features:
    • Create and manage ad campaigns
    • Track ad performance
    • Display ads in various sections of the site

User

The User module manages user profiles and user-related functionalities.

  • Features:
    • Perform CRUD (Create, Read, Update, Delete) operations on users
    • Assign roles to users
    • Deactivate users
    • Revoke email verification and other similar actions

Profile

The Profile module manages user profiles and user-related functionalities.

  • Features:
    • Edit personal information
    • Change email
    • Change password
    • Manage user social networks

Auth

The Auth module handles user authentication and authorization.

  • Features:
    • User registration and login
    • Password reset functionality
    • Email verification functionality
    • Role-based access control

Role

The Role module manages user roles and permissions.

  • Features:
    • Create and manage roles
    • Define permissions for each role
    • All site sections and operations are permission-based
    • Assign permissions to roles for comprehensive access control

MenuBuilder

The MenuBuilder module manages the creation and organization of site menus.

  • Features:
    • Create and manage menus
    • Add and arrange menu items
    • Support for nested menus
    • Define four types of menus:
      • main: Main navigation menu
      • submenu: Submenu items
      • category: Menu items for specific categories
      • parent_category: Menu items for parent categories

PageBuilder

The PageBuilder module enables the creation and management of custom pages with an intuitive and flexible interface.

  • Features:
    • Create custom pages
    • Manage the layout and content of pages
    • Support for various content blocks (text, images, videos, etc.)
    • Preview pages before publishing
    • SEO-friendly page settings

Home

The Home module manages the homepage content.

  • Features:
    • Configurable sections for featured articles, latest news, and more
    • Customizable layout

SEO

Manager

The SEOManager module handles SEO-related settings and optimizations.

  • Features:
    • Manage meta tags for articles
    • Manage meta tags for author pages
    • Manage meta tags for categories
    • Manage meta tags for tags
    • Manage meta tags for the homepage
    • Manage meta tags for the contact us page
    • Manage meta tags for the about us page
    • Manage meta tags for search pages
    • Optimize site for search engines
    • Track SEO performance
    • Create a sitemap for the site using the command: 
      php artisan sitemap:generate

RedirectManager

The RedirectManager module manages URL redirections within the site. It provides functionality to handle redirects efficiently, ensuring smooth user navigation and SEO benefits.

  • Features:
    • Create and manage URL redirects.
    • Define status codes for each redirect (e.g., 301, 302).
    • Toggle the status of redirects (active/inactive).
    • Cache redirects for optimized performance, with two caching methods:
      • Full List Cache: Cache all redirects in a single cache entry and search within this cached list.
      • Individual Cache: Cache each redirect individually, with searches performed against the specific cache entry for the requested URL.
    • Middleware to handle incoming requests and apply redirects based on the cached data.

FileManager

The FileManager module handles the upload and management of files.

  • Features:
    • Upload and manage images
      • View all uploaded images on the site
      • Edit existing images
      • Create new images
    • Upload and manage videos
      • Perform CRUD (Create, Read, Update, Delete) operations on videos
      • Generate and copy link for videos
      • Create custom and auto thumbnails for videos

Newsletter

The Newsletter module manages newsletter subscriptions and email campaigns.

  • Features:
    • Subscription form
    • Send newsletters to subscribers
    • Track email campaign performance

SocialNetwork

The SocialNetwork module manages social media integrations.

  • Features:
    • Share articles on social media
    • Users can register their own social media links
    • Administrators can register social media links for the site

ContactUs

The ContactUs module manages the contact form and incoming messages from users.

  • Features:
    • Contact form management
    • View and respond to messages

Hotness

The Hotness module tracks and displays trending content, including articles and tags, and allows administrators to mark them as "hot".

  • Features:
    • Mark articles as "hot"
    • Mark tags as "hot"

Seen

The Seen module tracks the views or interactions with various entities in the system. It provides a way to mark items as seen or unseen and track their visibility status.

  • Features:
    • Track views or interactions with various entities.
    • Associate seen status with different models.
    • Manage and update seen/unseen status of entities.

UserActivity

The UserActivity module meticulously tracks user interactions, requests, and activities within the News Portal, providing comprehensive insights into user engagement and site traffic patterns.

  • Features:
    • Session Management: Tracks user sessions, including IP addresses, device information, and geographic locations.
    • Request Logging: Logs each HTTP request made by users, recording URLs and referral sources for analytics.
    • Analytics: Provides insights into user engagement and site traffic patterns.
    • Security Enhancement: Middleware ensures that the IP address of authenticated users remains consistent throughout their session.

Setting

The Setting module handles the site-wide settings and configurations.

  • Features:
    • Manage site settings from the admin panel
    • Configure third-party integrations
    • About Us: Manage the "About Us" section of the site
    • Cache Management: Clear and manage cache settings
    • Site Details: Configure site-wide details such as site name, logo, and contact information
    • Social Networks: Manage social network links and integrations

Panel

The Panel module provides the administrative interface for managing the site.

  • Features:
    • Dashboard with site statistics
    • Management tools for all modules

Common

The Common module includes shared functionalities and utilities used across different modules.

Contributing

We welcome contributions to the News Portal project. If you find a bug or have a feature request, please open an issue on GitHub. If you'd like to contribute code, please fork the repository and submit a pull request.

License

The News Portal project is open-source software licensed under the MIT license. See the LICENSE file for more information.

Note: All modules in this project were developed by Mr1970, except for the frontend template, which utilizes a pre-built template that has been customized.

Note: The frontend template is in Persian, but all messages and sections in the backend code are read from translation files.

Thank you for using News Portal! If you have any questions or need further assistance, please feel free to contact us.