Pike Bootstrap 4 Kit documentation

Version 3.1


Getting Started #back to top


The kit contain 6 folders:

  • "_documentation" folder. This contain current documentation.
  • "admin_html" contain admin template in static HTML version.
  • "admin_php" contain admin template in dynamic PHP version.
  • "frontend_html" contain frontend cms template in static HTML version.
  • "frontend_php" contain frontend cms template in dynamic PHP version.
  • Pike Admin - HTML version #back to top

    "assets" folder contain all assets used in admin template:

  • "css" (for css files)
  • "data" - contain data used by charts and datatable plugins
  • "font-awesome" contain fontawesome icons (version 5)
  • "images" contain all media used in admin template (avatars, sliders, images)
  • "js" contain JavaScript files
  • "plugins" contain all plugins used in admin template, like colorpicker, charts, text editor, datatables and so...

  • How to use

    Create a folder named "admin" (or anything else) then upload all files from "admin_html" to your created folder. Default index (dashboard) file is index.html

    Pike Admin - PHP version #back to top

    "assets" folder contain all assets used in admin template:

  • "css" (for css files)
  • "data" - contain data used by charts and datatable plugins
  • "font-awesome" contain fontawesome icons (version 5)
  • "images" contain all media used in admin template (avatars, sliders, images)
  • "js" contain JavaScript files
  • "plugins" contain all plugins used in admin template, like colorpicker, charts, text editor, datatables and so...
  • "common" folder contain all php files that are common to all admin pages:

  • "footer.php" contain footer line (copyright) and common JavaScript files used in all template pages
  • "head.php" - contain head code that is common to all template pages (meta-charset, favicon, common css files)
  • "navbar.php" contain code for header navbar (horosontal menu from the top).
  • "sidebar.php" contain code for the left vertical sidebar

  • How to use

    Create a folder named "admin" (or anything else) then upload all files from "admin_php" to your created folder. Default index (dashboard) file is index.php

    Frontend CMS template - HTML version#back to top

    "assets" folder contain all assets used in admin template:

  • "css" (for css files)
  • "font-awesome" contain fontawesome icons (version 5)
  • "img" contain all media used in admin template (avatars, sliders, images)
  • "js" contain JavaScript files
  • Frontend template files:

  • "index.html" is the index file (homepage)
  • "category.html" contain contain code for all cms categories
  • "post.html" contain code for an article details page
  • "contact.html" contain contact page (contact form and Google Map)
  • "page.html" contain code for static pages (such as about-us, privacy...)
  • "gallery.html" is a custom template page who contain code for a image gallery
  • "author.html" contain articles list from a specific author
  • "coming-soon.html" is a custom page with a date countdown
  • "login.html" and "register.html" are pages who contain a login form / registration form

  • How to use

    Upload all files from "frontend_html" to your server. Default index (homepage) file is index.html

    Frontend CMS template - PHP version #back to top

    "assets" folder contain all assets used in admin template:

  • "css" (for css files)
  • "font-awesome" contain fontawesome icons (version 5)
  • "img" contain all media used in admin template (avatars, sliders, images)
  • "js" contain JavaScript files
  • "common" folder contain all php files that are common to all frontend template pages:

  • "footer.php" contain footer area code and common JavaScript files used in all template pages
  • "head.php" - contain head code that is common to all template pages (meta-charset, favicon, common css files)
  • "navbar.php" contain code for header (horosontal menu from the top).
  • "sidebar.php" contain code for the right vertical sidebar
  • "slider.php" contain code homepage slider carousel
  • Frontend template files:

  • "index.php" is the index file (homepage)
  • "category.php" contain contain code for all cms categories
  • "post.php" contain code for an article details page
  • "contact.php" contain contact page (contact form and Google Map)
  • "page.php" contain code for static pages (such as about-us, privacy...)
  • "gallery.php" is a custom template page who contain code for a image gallery
  • "author.php" contain articles list from a specific author
  • "coming-soon.php" is a custom page with a date countdown
  • "login.php" and "register.php" are pages who contain a login form / registration form

  • How to use

    Upload all files from "frontend_php" to your server. Default index (homepage) file is index.php

    Pike CMS Framework #back to top

    General Info - #back to top

    Light and easy to use PHP framework build on modern MVC architecture to build responsive websites in just a few minutes.

    Features

    Registration / Login / Users / Users Roles

    We build a complete framework to manage your users: user registration (you can enable / disable in admin area), email verification, forgot password, reset password, user login. 3 users roles implemented: admin (global access), editor (can manage all articles) and registered users (manage own articles)

    Front-End CMS Template based on Bootstrap 4

    Save dozens of hours for developing your own theme! We make a simple, clean and optimised front-end theme based on Bootstrap 4 framework to help you starting a new project. SEO is very important for us so we optimised all pages for best experience for visitors and search engines.

    Blog / articles system

    With this feature, you can start a blog / articles website in just a few minutes.

    Contact Messages Management

    Every website needs a contact page to interract with the visitors. We implement a powerful contact page with a contact form. Contact messages are managed in admin area. Alslo you can send a reply to message author directly in amin area.

    Slider Carousel

    In front-end homepage template we implement a slider carousel. Slides can be managed in admin area (add slide image, title, description, redirect url...)

    Static pages

    Add static pages in admin area to show in frontend template


    How to install - #back to top

    STEP 1: Unzip and copy script files and folders on the server (without "_sql" folder). You can install it on localhost too.

    STEP 2: Make writable (chmod 777) "public/temp" folder and "public/uploads" folder and all subfolders ("avatars", "img", "media")

    STEP 3: Create a database and a user for that database (eg. in cPanel -> MySQL Databases)

    STEP 4: Import mysql tables file from "_sql" folder. Steps to import a file: - Go to phpMyAdmin (or another database management script) - Select your database - Click on "Import" button - Choose file to upload (located in "_sql/tables.sql) - Upload (import) file

    STEP 5: Edit the file "config.php" located in "app/config" folder.

    STEP 6: Edit the file "database.php" located in "app/config" folder and add database connect details.

    STEP 7: Login in admin area. Default admin connection details are: admin@website.com (as email) and 123456 (as password). You can change this details in admin area (my profile).


    If you install it on localhost:

    - in "app/config/config.php" define ('SITE_URL', 'http://localhost'); // no ending slash

    If you install on a subfolder:

    - rename and replace .htaccess_for_subfolder file as .htaccess

    - in "app/config/config.php": $router->setBasePath('/your_subfolder')

    - if you install in localhost: "app/config/config.php" define ('SITE_URL', 'http://localhost/your_subfolder'); // no ending slash

    - if you install on domain / subdomain: "app/config/config.php" define ('SITE_URL', 'https://your-website.com/your_subfolder'); // no ending slash


    Requirements - #back to top

    - Like all important frameworks, PHP 7 is required (it doesn't work on old PHP 5).

    - PDO extension enabled (it is enabled by default).

    - MySQL database.

    - Apache web server with ModRewrite (for htaccess support).

    - Script can be installed on a root domain or subdomain but it works on any subfolder. It works on localhost too.


    System folder - #back to top

    "system" folder contain all core (system) controllers, models, views, routes and authentification used in backend area (admin area)

    Usually you don't have to change anything in this area


    Apps folder - #back to top

    "app" folder

    "config" folder contain configuration file and database connection

    "controllers" folder contain controllers classes

    "controllers" folder contain controllers classes

    template.php file located in "app/controllers/" contain code related to all pages from front-end template (homepage, categories, blog post, authors articles, contact page and so on...)

    "models" folder contain models classes

    "routes" folder contain apps routes used in frontend template and backend area

    "views" folder contain views files (template files) used in backend area only

    Public folder - #back to top

    "views" files that render the front-end template are located in "public/templates/template_name/" folder.

    "assets" folder contain assets used in backend and frontend (css, javascripts, plugins, icons...)

    "temp" folder must have write access (chmod 777)

    "templates" folder contain frontend template files. If you create a new template folder, you must setup this folder in admin area (in general settings)

    "uploads" folder contain files uploaded, such as avatars, articles images, sliders images, other images...


    Vendor folder - #back to top

    "vendor" folder conmtain classes / functions from third-party vendors (such as image resize class, smtp class...)

    Support Desk #back to top

    We provide free updates for minor version changes. Example: If you buy version 3.1.1, you will get for free updates like 3.1.2, 3.2.1... (any 3.x.x. version) This free updated versions will be available to download in your account.

    Upgrades to new versions (from 3.x.x to 4.x.x) are considered new software and you must buy them as a separate product.

    Our free support is related to fix bugs or errors only for your bought product.

    Support for "how to..." questions or providing custom modification is a paid support.

    Copyright and license #back to top

    If you bought the product, you are allowed to edit copyright links to point to your website.

    A license grants you a non-exclusive and non-transferable right to use and incorporate the item in your personal or commercial projects.

    Single License

    - Your use of the item is restricted to a single installation.
    - You may use the item in work which you are creating for your own purposes or for your client.
    - You must not incorporate the item in a work which is created for redistribution or resale by you or your client.
    - The item may not be redistributed or resold.

    Extended License

    - This license must be purchased if you intend to license, sublicense, redistribute, or resell the final product.
    - Your use of the item may extend to multiple installations.
    - You may use the item in work which you are creating for your own purposes or for your clients.
    - You may license, sublicense, redistribute, or resell the item if the item is incorporated into a larger work you have created or if you modify the item and resell the end product.

    Version History (Changelog) #back to top

    Changelog

    
                                            -----------------------------------------------------------------------------------------
                                            Version 3.1.1
                                            Release: June 15, 2019
                                            Filename: pike-kit-3.1.1.zip
                                            -----------------------------------------------------------------------------------------
    
                                            - First release of a complete Bootstrap 4 suite.