Merge pull request #92 from bbertucc/MVP-3.1

MVP 3.1: Scan updates

Author: Blake Bertuccelli

CONTRIBUTING.md

@@ -18,21 +18,7 @@ Fixes and reports of A11Y or UX errors are greatly appreciated.
 
 I'm up for any new coding standards!
 
-**Every error is reported with an `Exception`.**
-
-Exceptions allow me to log errors. 
-
-**I consider User Errors System Errors.**
-
-What some platforms display a warning for, like "wrong password," I ring alarm bells for.
-
-I do this because I think good UX should be seamless.
-
-Users should never hit roadblocks.
-
-**There is no authorization system.**
-
-Equalify is being designed as open as possible.
+As for governance and a code of conduct, checkout my [discussion around governance](https://github.com/bbertucc/equalify/discussions/91).
 
 ## Usable hooks and patterns. 
 
@@ -41,9 +27,7 @@ Checkout [/models/hooks.php](/models/hooks.php) and the `_scan` pattern in [/act
 ## Progress Depends on Bugs
 I am inspired by the development of [Gutenberg](https://github.com/WordPress/gutenberg).
 
-A community of engaged devs builds the future of WordPress around issues that are reported by users.
-
-I hope folks, no matter their expertise, contribute to Equalify.
+A community of engaged devs builds the future of WordPress around issues that are reported by users. Checkout the [Help Wanted](https://github.com/bbertucc/equalify/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [Good First Issue](https://github.com/bbertucc/equalify/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tags for issues that we need particular help on.
 
 We can build a more accessible internet together.
 

README.md

@@ -1,54 +1,42 @@
-# Equalify the web!
+# Equalify Pro
 
-**96.8% of homepages have WCAG conformance failures,** according to [WebAIM](https://webaim.org/projects/million/).
+Open Source projects like Equalify need a revenue stream to keep their work alive.
 
-The internet must become more accessible!
+So, if we're going to make Web Accessibility better, we gotta make some dough!
 
-## Support Equalify
+## Pro Features
 
-⭐ **Star the repo** to show your support.
+A managed "service" version of Equalify includes:
+- Hosted Service
+- Chat Support
+- View-based alerting
+- Enhanced notifications 
+  - Send alert by alert email
+  - View-based alerts
+  - Bundle alerts into weekly/monthly summaries.
+- Add multiple accounts to a "team"
+- "Team" Management 
+  - Assign alerts as "tasks" for different team members
+  - Track completion of tasks
 
-🌸 **Try our managed service**, [equalify.app](https://equalify.app/).
+## Pro Pricing
 
-🛠️ **Contribute a pull request** or [new issue](https://github.com/bbertucc/equalify/issues).
+Pricing starts at $1,400/yr for 1 team member and 10,000 annual alerts.
 
-🎩 **[Donate](https://equalify.app/donate/)** to Equalify.
+Add $99/yr for every new team member and $99/yr for every additional 1,000 annual alerts.
 
-## How will Equalify increase content accessibility?
+## Other Notes
 
-Equalify aims to:
-1. **Promote transparency** with a Open Source A11Y platform (✅ Done!).
-2. **Reduce the cost** of multi-page website scans (ongoing).
-3. **Improve automation** to simplify WCAG issue resolution (2023). 
+Making money can cloud purpose.
 
-We will tackle these goals by integrating with existing web services, making Equalify your WebOps hub. 
+The purpose of Equalify, and my life, is to do ethical good.
 
-![equalify-integrations](https://user-images.githubusercontent.com/46652/188710874-e53ccb85-f542-46f3-a680-837aaf02ae92.png)
+Here's a basic comparison of Open Source vs. Proprietary projects from [An Open Source Survey](https://www.researchgate.net/publication/265411256_Open_Source_Software_A_Survey_from_10000_Feet):
 
-## What does Equalify currently do?
+![1B3C7CE8-691B-4403-9B81-73BC7E077D89](https://user-images.githubusercontent.com/46652/169911414-6123539e-fb9f-49e4-b663-2c4cfd2172b0.jpeg)
 
-The app currently scans websites for WCAG errors.
+It should go without saying that the values of Open Source projects are more ethical than the values of proprietary projects.
 
-You can import pages from WordPress, XML sitemaps, and single URLs. Equalify then crawls all your pages for WCAG 2.1 errors using the popular [WAVE scan](https://wave.webaim.org/).
+If the Pro plan is indeed designed to sustain Equalify, we must focus on that goal (and temper our desires with [basic income nest eggs](https://bbertucc.notion.site/Basic-Income-Nest-Eggs-4b555b09d02d40389086c01ec84c1424)).
 
-Every alert is reported on a filterable dashboard.
-
-![equalify-alerts](https://user-images.githubusercontent.com/46652/188710908-9bfb7da8-68ff-490c-8d6b-f9ce1f38d4c8.png)
-
-## Download and Use
-1. Download or clone [the latest release](https://github.com/bbertucc/equalify/releases).
-2. Change `sample-config.php` to `config.php` and update info.
-3. Run `composer install` to install Composer dependencies.
-4. Upload/run on a Linux server (PHP 8 + MySQL required).
-5. Report [issues](https://github.com/bbertucc/equalify/issues), questions, and patches.
-
-**Not a technical user?** Use Equalify now at [equalify.app](https://equalify.app/).
-
-## Special Thanks
-A chaos wizard 🧙 and many brilliant brains help Equalify. Special shoutout to [Pantheon](https://pantheon.io/) and [Little Forest](https://littleforest.co.uk/feature/web-accessibility/) for providing funding for [bounties](https://github.com/bbertucc/equalify/issues?q=is%3Aopen+is%3Aissue+label%3Abountied). Yi, Kate, Bill, Dash, Sylvia, Anne, Doug, Matt, Nathan, and John- You are the brains behind any great idea. Brad- You push me to code better. [@ebertucc](https://github.com/ebertucc) and [@jrchamp](https://github.com/jrchamp) are the project's first contributors - woot woot! [Guzzle](https://github.com/guzzle/guzzle) makes multiple concurrent scans possible. [Composer](https://getcomposer.org/) makes Guzzle possible.
-
-This project is Open Source under [AGPL](https://github.com/bbertucc/equalify/blob/mvp-1.2/LICENSE) to inspire new collaborations.
-
-Together, **we can equalify the internet**.
-
--[@bbertucc](https://github.com/bbertucc)
+Onward and upward!

actions/activate_alert.php

@@ -7,6 +7,7 @@
  * Equalify works for everyone.
 **********************************************************/
 
+
 // Info on DB must be declared to use db.php models.
 require_once '../config.php';
 require_once '../models/db.php';

actions/add_site.php

@@ -1,5 +1,12 @@
 <?php
-// ***************!!EQUALIFY IS FOR EVERYONE!!***************
+/**************!!EQUALIFY IS FOR EVERYONE!!***************
+ * This document adds a site.
+ * 
+ * As always, we must remember that every function should 
+ * be designed to be as efficient as possible so that 
+ * Equalify works for everyone.
+**********************************************************/
+
 
 // Info on DB must be declared to use db.php models.
 require_once '../config.php';

actions/delete_label.php

@@ -7,6 +7,7 @@
  * Equalify works for everyone.
 **********************************************************/
 
+
 // Info on DB must be declared to use db.php models.
 require_once '../config.php';
 require_once '../models/db.php';

actions/get_alert_count.php

@@ -7,6 +7,7 @@
  * Equalify works for everyone.
 **********************************************************/
 
+
 // Since this file can run in the CLI, we must set the 
 // directory if it isn't already set.
 if(!defined('__ROOT__'))

actions/get_scan_log.php

@@ -7,6 +7,7 @@
  * Equalify works for everyone.
 **********************************************************/
 
+
 // Since this file can run in the CLI, we must set the 
 // directory if it isn't already set.
 if(!defined('__ROOT__'))

actions/get_scan_status.php

@@ -7,6 +7,7 @@
  * Equalify works for everyone.
 **********************************************************/
 
+
 // Since this file can run in the CLI, we must set the 
 // directory if it isn't already set.
 if(!defined('__ROOT__'))

actions/ignore_alert.php

@@ -7,6 +7,7 @@
  * Equalify works for everyone.
 **********************************************************/
 
+
 // Info on DB must be declared to use db.php models.
 require_once '../config.php';
 require_once '../models/db.php';

actions/run_scan.php

@@ -0,0 +1,22 @@
+<?php
+/**************!!EQUALIFY IS FOR EVERYONE!!***************
+ * This is the scanner, Equalify's core. 
+ * 
+ * As always, we must remember that every function should 
+ * be designed to be as efficient as possible so that 
+ * Equalify works for everyone.
+**********************************************************/
+
+// Since this file can run in the CLI, we must set the 
+// directory if it isn't already set.
+if(!defined('__ROOT__'))
+    define('__ROOT__', dirname(dirname(__FILE__)));
+
+// We'll use the directory to include required files.
+require_once(__ROOT__.'/helpers/scan.php');
+
+// Run the scan.
+run_scan();
+
+// After everything is complete, we return home.
+header('Location: ../index.php?view=scan');