Base Template

Branch	Build	Coverage
Master
Develop

Starter repository for creating a new website. Live demo can be found at https://base.wayne.edu/.

Features

• Backend built on Laravel
• Frontend built on Tailwind
• Module bundling using Webpack
• Fluent webpack API using Laravel Mix
• Zero downtime deployment using Envoy
• Configure multiple enviorments using PHPDotenv
• SCSS support
• Automatically inject JS/CSS while developing using BrowserSync
• 100% test code coverage
• Public API documentation
• Commit hook that require the following to pass:
  • Tests using PHPUnit
  • PHP linting using Laravel Pint
  • JS linting using ESLint
  • CSS/SCSS linting using Stylelint
• Menus
  • Top level menu carried across all pages that follows you down the page as you scroll
  • Left menu if a page has subitems, otherwise its a full width page
  • Slideout menu that is triggered on a variable breakpoint that includes
    • The top level menu grouped together
    • Left menu
    • Under menu promotions
    • Banner promotion
• Full styleguide detailing out every available component using PHP faker data
• Single or rotating hero images using Flickity
• Automatically lightbox youtube videos using Media Box
• Easy integration with a CMS by writing custom .json files to the public directory which are matched by to a route and sent to the specified controller

Setup

1. Setup laravel homestead: http://laravel.com/docs/homestead
2. Clone the repository
3. run make install
4. run make build
5. run make watch
6. open https://domain.local:3000/ (for BrowserSync)

Deployment

• Setup the following config variables in Envoy.blade.php
  • $appname
  • $server_map
  • $source_repo
  • $deploy_basepath
• Development: envoy run deploy or make deploy
• Production: envoy run deploy --on="production" or make deployproduction
• Any branch: envoy run deploy --branch=feature/feature

Run tests

phpunit

Run test coverage

1. make coverage
2. Open the coverages/index.html file in your browser

Check for outdated packages

make status

Update packages

make update

Configure the site

1. Open /config/base.php
2. Edit the options to configure the site, some values are present in the .env file.
3. Server specific configuration options come from the .env file which need to be manually created/updated on the servers the app is deployed to.

Request a WSU API key

Email web@wayne.edu with your request.

Adding .env variables

1. Add a config option to config/base.php called your_key using the env() function.
2. Using it in blade: <script>var KEY = { API_KEY: {{ config('base.your_key' }} };</script> .
3. Using it in PHP: <?php $key = config('base.your_key'); ?>
4. Add a blank entry to your local .env.example file for your_key
5. Add an entry with the actual value to your local .env file.
6. Commit the .env.example file. You may want to put the actual value in the example file when necessary.
7. Once the site is deployed you will want to add the actual value to the .env on each server.

Developing global data that is passed down to all views via the $request->data variable

1. Open the folder /app/Repositories.
2. Create new class and implement the interface RequestDataRepositoryContract.
3. Fill out the getRequestData method and return an array.
4. Add the callback under the site in config/base.php

Developing controllers

1. Open the folder /app/Http/Controllers/
2. This folder contains all the selectable templates from the CMS.
3. Controllers should:
   • Dependency inject repositories into the constructor.
   • Call repositories to obtain data to send to the view.

Developing views

1. Open /resources/views/
2. This folder contains all the views for the front-end using the blade templating engine
3. Files must be saved in the format of: homepage.blade.php
4. Components: Contains views that are reusable

Pages

Pages are written from the content management system automatically. To replicate what it writes you can use the following JSON format to create pages. Example homeage: storage/app/public/index.json.

{
    "site" : {
        "id" : 1,
        "title" : "Base Site",
        "subsite-folder" : null,
        "parent" : {
            "id" : null
        }
    },
    "page" : {
        "id" : 1,
        "controller" : "HomepageController",
        "title" : "Welcome!",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed turpis lorem, malesuada eu tellus vel, pharetra consequat lacus. Vestibulum eu metus nec massa viverra iaculis. Pellentesque libero eros, varius non sem et, dapibus aliquam magna. Praesent ultri",
        "content" : {
            "main" : "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed turpis lorem, malesuada eu tellus vel, pharetra consequat lacus. Vestibulum eu metus nec massa viverra iaculis. Pellentesque libero eros, varius non sem et, dapibus aliquam magna.</p>"
        },
        "keywords" : "",
        "updated-at" : "",
        "canonical" : ""
    },
    "menu" : {
        "id" : 1
    },
    "data" : {

    }
}

Menus

Menus are automatically pulled from the content management system. To replicate the structure you can use the following array and replace the code in App\Repositories\MenuRepository@getAllMenus.

<?php

$menus = [
    1 => [ // The menu_id specified from the .json file
        1 => [ // First menu item
            'menu_item_id' => '1', // Auto incrementing ID
            'is_active' => '1', // To output the menu item or not
            'page_id' => '1', // Page ID specified from the .json file
            'target' => '', // HTML <a target="">
            'display_name' => 'Home', // Title of the menu item
            'class_name' => '', // CSS class name to be appended to the menu item
            'relative_url' => '/', // The relative URL to this page
            'submenu' => [], // Subitems, follow same structure and include another submenu => []
        ],
        2 => [ // Second menu item...

        ],
    ],
];

News listing & view

1. Create a CMS page called news in the root of the site and select the ArticleController as the template.
2. Create a CMS page called news/topic in the root of the site and select the ArticleController as the template.
3. Create a CMS page called news/topics in the root of the site and select the TopicController as the template.
4. If you need news for a subsite, follow these steps again while being within that subsite.

Profile listing & view

1. Create a CMS page for the profile listing page (ex: profiles) and select the ProfileController as the template.
2. Create a CMS page for the profile view, it must be: profile and select the ProfileController as the template.
3. You can now visit https://domain.local/profiles and http://domain.local/profile/{accessid}.

Style guide development for a new feature

Feature names should be singular and CamelCased. To create a new feature called "Spotlight": php artisan base:feature Spotlight

Adding SVG icons

1. Load the fontello-config.json file into http://fontello.com/
2. Select the new icons and download the set.
3. Load the waynestate.svg file into https://icomoon.io/app/#/select
4. Select all the icons and download the set.
5. Open the new SVG icon(s) in the editor of your choice.
6. Save each file under resources/views/svg as a blade partial.
7. Remove the comment from the svg file.
8. Apply this code to the svg tag: class="{{ $class ?? '' }}" aria-labelledby="{{ $name ?? '' }}".

Using SVG icons

1. <svg> replace with: @svg('filename', 'optional classes', 'optional label')

Lazy loading

1. <img> replace with: @image('/path/to/image.jpg', 'alt text', 'optional classes')
2. Background images: <div data-src="/path/to/image.jpg"></div>

Contributing

Please see CONTRIBUTING for details.

Licensing

Base Template is open-sourced software licensed under the MIT license.