Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 8.98 KB

README.md

File metadata and controls

106 lines (74 loc) · 8.98 KB
Raw

Workstation Ordering Application for WordPress

Web Team > Information Technology > Dean's Office > College of Liberal Arts > Texas A&M University > Texas A&M University System

A GNU GPL 2.0 (or later) WordPress Theme to facilitate product ordering within a robust, multi-role return / approve workflow using team-based settings.

Features

  1. Responsive design
  2. HTML5 elements
  3. Accessible

WordPress Requirements

  1. Single site install
  2. Genesis Framework - WordPress Theme
  3. Workstation Ordering Application Plugin a. https://github.tamu.edu/liberalarts-web/cla-workstation-order b. https://github.com/tamulibarts/cla-workstation-order
  4. WSOrder WordPress Child Theme a. https://github.tamu.edu/liberalarts-web/cla-wsorder b. https://github.com/tamulibarts/cla-wsorder
  5. Advanced Custom Fields Pro Plugin

WordPress Recommendations

  1. TAMU NetID authentication plugin of some kind, we use an in-house CAS plugin and may switch to SAML SSO OneLogin.
  2. Post SMTP Plugin - Send emails by SMTP with a logger and one-click resend button in case of failed delivery
  3. User Switching Plugin - For imitating user accounts in case that is desired functionality. The github.com repository is updated more frequently than the WordPress repository.
  4. Yoast Duplicate Post Plugin - Copy custom post types.
  5. Simple History Plugin - For debugging and user support.

Developer Notes

Frameworks and Libraries

It relies on Advanced Custom Fields Pro for ease of implementation and modification of data relationships for users and developers. It uses ACF hooks to trigger custom actions when ACF fields are updated.

It uses SASS for CSS preprocessing and Zurb Foundation 6 as a CSS framework.

Code Standards, Guidelines, and Conventions

There are many ways to learn programming and rigid documentation requirements can seem daunting for beginners. If you are a beginner, I am excited that you are here and I hope you learn something from what you find here. While not a requirement to write functional code, the additional steps required to learn and implement best practices for documentation is worthwhile for both personal and professional projects.

"WordPress is a big project with thousands of contributors. It’s important that best practices are followed so that the codebase is consistent and readable, and changes are easy to find and read, whether the code is five days old or five years old. What follows are a series of best practices to help keep WordPress code clean and well documented for years to come." View more: https://developer.wordpress.org/coding-standards/

"WordPress uses a customized documentation schema that draws inspiration from PHPDoc, an evolving standard for providing documentation to PHP code, which is maintained by phpDocumentor." View more: https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/

I use the Composer module for PHP CodeSniffer to automate code compliance with WordPress Coding Standards. However, this repository is not yet fully compliant with those standards. A pre-commit hook file is included in this repository to enforce code commits to meet this standard but can be disabled when a situation warrants it, such as backing up unfinished work via a commit.

Git, NPM, and Visual Studio Code files in this repository help improve compatibility between Mac (terminal) and Windows (powershell) environments for improved collaboration between developers.

Line endings are converted to Linux-style LF "\n" when committed to the repository using the .gitattributes file. This is what WordPress requires for its Subversion version control system, and Subversion is how developers submit WordPress plugins and themes to the official WordPress.org library. This is an important feature because Windows computers add "\r\n" characters to the end of text lines when a line is broken. View more: http://git-scm.com/docs/gitattributes#_end_of_line_conversion

Links to resources:

Command Line Tasks

  1. $ npm start - Used to initialize the repository; should only be run after downloading the repository for the first time.
  2. $ npm run configphpcs - Configure the PHP Code Sniffer module to use WordPress Coding Standards.
  3. $ npm run checkwp - Checks the repository's WordPress files against the WordPress Coding Standards and outputs a report into your terminal.
  4. $ npm run fixwp - Automatically fixes syntax and whitespace issues with the repository's files according to WordPress Coding Standards.
  5. $ npm run windows-configphpcs - The same as $ npm run configphpcs but with Powershell-friendly syntax.
  6. $ npm run windows-start - The same as $ npm start but with Powershell-friendly syntax.
  7. $ npm run windows-checkwp - The same as $ npm run checkwp but with Powershell-friendly syntax.
  8. $ npm run windows-fixwp - The same as $ npm run fixwp but with Powershell-friendly syntax.
  9. $ grunt - Compile SASS files into compressed, production-ready CSS files.
  10. $ grunt develop - Compile SASS files into expanded, sourcemapped CSS files.
  11. $ grunt watch - Continuously watch SASS files for changes and compile them into expanded, sourcemapped CSS files every time they are saved.
  12. $ grunt compress - Create a compressed package file named cla-workstation-order.zip that can be uploaded to your WordPress website's plugin dashboard.

To Do

  1. Implement Active Directory user authentication, onboarding, and offboarding using either the WordPress SAML SSO plugin from OneLogin, the TAMU directory REST API https://mqs.tamu.edu/rest/, or both and one or more WordPress Cron tasks or manual functions.
  2. Remove the following form fields from the edit-user.php administrative UI since they are not used: Visual Editor, Keyboard Shortcuts, Website, Biographical Info, Profile Picture, New Password, Password Reset.
  3. Change the NPM scripts for Windows
  4. Consider implementing a custom XML ruleset file for PHP CodeSniffer
  5. Replace NPM package grunt-sass-lint with something that isn't abandoned

Potential Installation Issues

Windows 10 application issue: "Local" by Flywheel (local virtual server)

https://localwp.com/help-docs/advanced/router-mode/ On two different models of Dell Windows 10 machines (Inspiron and Latitude) a Windows service was occupying Port 80 on IP 0.0.0.0:80. This interferes with the "Local" application's router functionality which uses the same port and is not configurable. It is possible that this becomes an issue as a direct result of a change made by the NodeJS *.exe file's installation process since I did not have this issue with the application until after installing NodeJS this way. ON MY PERSONAL COMPUTER I installed NodeJS using Chocolatey CLI and did not experience these conflicts with Port 80 and "Local". NOTE: SEE YOUR SYSTEM ADMINISTRATOR FOR POLICY GUIDANCE REGARDING THE INSTALLATION OF SOFTWARE ON TAMU SYSTEM DEVICES.

Credits

  1. The WordPress plugin was programmed by Zachary Watkins zwatkins2@tamu.edu https://github.com/zachwatkins.
  2. The WordPress theme was programmed by Zachary Watkins.
  3. The business process workflow and a portion of the UI specifications were designed by Pamela Luckenbill.
  4. The original application used very different technology, was programmed by Joseph Rafferty jrafferty@tamu.edu, and was authored by Joseph Rafferty and Pamela Luckenbill: https://github.tamu.edu/liberalarts-web/workstation-order.
  5. The majority of the workflow requirements for this version were preserved from the original application. However, the product, bundle, program, and department data creation and management interface is superseded by this application as it is provided by WordPress Core.
  6. The visual design at the start of the project was copied from the original application, and then the icons were replaced.

Fun Facts

To add an executable file to git version control, do this: git add --chmod=+x hooks/pre-commit && git commit -m "Add pre-commit executable hook"