alanef / fullworks-scanner

Fullworks Vulnerability Scanner - WordPress Plugin

A WordPress Plugin that analyses the WP version, plugins and themes checks them against a vulnerability database

Table of Contents

• Description
• Getting XXStarted
  • Prerequisites and Main Dependencies
  • Installation
• Usage
• Testing
• Deployment
  • Server
  • Branches
• Additional Documentation
• Changelog
• Roadmap
• Authors
• Contributors ✨ and Acknowledgments
• Contributing
• License

Description

A WordPress Plugin that analyses the WP version, plugins and themes checks them against a [vulnerability database] https://vulnerability.wpsysadmin.com/ and also checks or out of date plugins and themes against the WordPress repository. The plugin helps improve the security of WordPress sites by providing a centralised view of the security status of the site.

Getting Started

Prerequisites and Main Dependencies

• You need this
• And you need this
• Oh, and don't forget this

Installation

How do you install the project and what do you need for it? Mention all dependencies that need to be installed first. Ideally, you also provide version numbers. (I’m looking at you, Node.js…)

Example:

npm install our-lovely-project --save

Usage

Instructions for how to configure, run, and use the project. For example, you can include the commands needed to install and start the development environment or any other useful and important commands. Screenshots can be included as well.

For more examples and usage, please refer to the Documentation.

Testing

Any unit or integration tests people can run to assure that everything’s working as expected? Any frameworks or commands that are needed here? And are there any tests in your deployment pipeline that ensure that no errors make it into the live site?

Also include the commands needed to run any tests:

npm run test

Deployment

Instructions for how to deploy the project to a production environment, including any server requirements and commands used. And, in case you are using a CI/CD pipeline, for example, how do any automated processes work? What are the most important branches? Do they trigger any pipelines?

Server

• Live:
• Staging:
• Development:

Branches

• Master:
• Feature:
• Bugfix:
• etc...

npm run build

Additional Documentation

Changelog

We use Semantic Versioning for versioning.

• 1.0.1

  • Fix sanitization issue (Thanks [e-mail]!)
  • Change counter to use to not display when zero

• 1.0.0

  • First submission to WordPress.org

Roadmap

• Release to WordPrress.org

Authors

• Alan Fuller - Fullworks Plugins - alanef

Contributors ✨ and Acknowledgments

• Thanks to [e-mail] for their review and feedback

Contributing

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Important: WordPress coding standards should be used

License

Distributed under the GPL3 license. See GPL3 for more information.