cyberwani / includewp

IncludeWP.com, A leaderboard of top open-source frameworks for WordPress plugin & theme developers. Because code reusability is awesome! https://includewp.com

IncludeWP

IncludeWP.com, a leaderboard of the top open-source frameworks for WordPress plugin & theme developers.

Why?

Because code reusability is awesome!

Earlier this year (March 2016), the WordPress.org plugins review team issued a statement on make.wordpress.org that frameworks are no longer allowed in the official plugins repository. So... we decided to build a new cozy home for all frameworks, making it easier for developers to finds what's out there to reuse before starting to work on a new project.

Contributing

Missing a framework here? Just fork the repo and add your framework as a {name}.php in the src/frameworks folder.

Make sure to follow the following rules:

• Frameworks only: We only accept projects (frameworks, libs, SDKs) that other theme and plugin developers can include into their theme or plugin. One exception - we also accept starter themes and plugin boilerplates.
• GPL Compatible License: The framework must be licensed with a GPL compatible license so plugins and themes that use it can be listed on WordPress.org.
• GitHub: The framework must have a public repository on GitHub that we can link to and pull in stats from.
• Stick to the format: Fill out all the same fields as the other frameworks in src/frameworks.
• WordPress.org (optional): If the framework is listed as a plugin on wp.org, please add a reference to the plugin's slug.
• Short description: Keep the description for the overview page short and sweet. No need to mention it's a "framework" or adding "WordPress" in it. Please keep it informative, it's not a sales pitch :)
• Thumbprint: If you want the framework to automatically list all plugins & themes from WordPress.org that are using it, you need to provide a unique combination of a file name and a string, which we'll use for identification. The string should appear in the specified file. If you are adding a starter theme, make sure that the thumbprint is not changed when implementing the theme.

Running locally

IncludeWP is built on pure PHP and JavaScript so it should be working out of the box.

If you'd like to keep the GitHub stats and framework screenshots up to date, you should execute cronjobs/weekly-update.php on a weekly basis. Before you do that, you'll need to update includes/config.php with your keys/tokens:

1. Sign-up for a free account via Page2Images and set PAGE_2_IMAGES_REST_KEY & PAGE_2_IMAGES_KEY with your keys.
2. Create your personal GitHub token and set GITHUB_ACCESS_TOKEN with the token.

What do we use?

Frontend

• Materialize
• jQuery
• Font Awesome
• Google Fonts

APIs

• Addendio: Pulling WordPress.org plugins & themes based on a slug (private API by Addendio).
• GitHub: Pulling the framework's GitHub repo stats (https://api.github.com).
• WordPress.org Plugins: Pulling the framework's banner (https://api.wordpress.org/plugins/info/1.0/).
• Page2Images: Generating a screenshot of the framework's homepage (http://api.page2images.com).
• Cloudinary: Images CDN (https://res.cloudinary.com).

Freemius

IncludeWP is built and maintained with ❤ by Freemius -- Analytics, Monetization and Marketing Automation platform for WordPress theme & plugin developers.

A big shout out to Luca Fracassi from Addendio, a search engine for WordPress plugins & themes, who helped us detecting on which WordPress plugins/themes frameworks are being used.

License

This project is licensed under the MIT license.