elkarte/addons

Addons for ElkArte community forum software

This is the ElkArte Development repository. If you are looking for the currently released branch go here

ElkArte is a modern, free, powerful community forum building forum software. It is completely free and licensed with an open source BSD 3-clause license.

Initially based on Simple Machines Forum (SMF), it began as an overhaul of the code; to modernise, implement new features and make a forum software more relevant in a time of unprecedented social interaction. It has grown to become a modern and feature rich forum package to meet the demands of today's message board user.

Enjoy the benefits of enthusiasts from around the world who spend time making ElkArte what it is today.

Test ElkArte yourself by visting our support forums at ElkArte.net.

Contributions to documentation are licensed under CC-by-SA 3. Third party libraries or sets of images, are under their own licenses.

A small taste of ElkArte features

• @Mentioning users including notifications
• Like system for posts and topics, with a like statistics page
• Notification system for mentions, quoted posts, likes, PM's
• Drafts, including auto save
• Emoji integrated into the editor provides access to 1000's of them 😃
• Inline Attachments allow displaying of attachment thumbnails inline with the text of the post
• Two factor authentication
• Two built in modern, responsive themes
• Desktop notifications and number of unread notifications "live" in the favicon of the browser
• Integrated video embedding for YouTube, Vimeo, TikTok and Dailymotion
• Drag and drop ordering in the administration interface
• Drag and drop file attachments with live view
• Built in image attachment lightbox with swipe/arrow navigation
• Improved Anti Spam measures
• Improved password security using industry standards
• Automatic combining and minifying of JavaScript and CSS
• Posting and replying by Email
• Ajax previews and responses throughout the user interface

Requirements

• ElkArte version 2.0 (under development / this repo) will require PHP version 7.1 or newer
• MySQL 5.7+, Mariadb 10.2+ OR PostgreSQL 9.5+

On the client side, ElkArte will run & look good with its responsive theme in just about any modern browser, smartphone or tablet.

Setting up an ElkArte Forum:

If you're not here to play with the open source code, but instead would like to set up an ElkArte forum, follow these steps. Since ElkArte is built to be simple to use, its installation is no exception.

• Create a database for your forum using a tool like PHPMyAdmin or Adminer
• Get the latest Install Package for ElkArte.
• Upload and extract the entire file structure up to your web server.
• Confirm the folders are writable by PHP.
• Navigate to that folder in your web browser
• Follow the instructions on screen.
• Enjoy !

ElkArte is also available to install from cPanel for Softaculous users!

Migrating to ElkArte

Switching to ElkArte is fast and easy!

Simply install ElkArte using our Quick Installer (as outlined above), then utilizing the Open Importer Engine you can migrate to ElkArte from many other popular forums including SMF, phpBB, MyBB, vBulletin, XenForo and more.

Extend ElkArte

ElkArte was built to be extensible, so you can add new features or give it your own custom look, with ease. With 100's of plugin hooks and an event system, adding new features can be done without any involved source edits.

Browse the collections of Themes and Addons created by our awesome community

Contributing:

• Troubleshoot issues you run into on the ElkArte community forum so others can help & the developers can reference it later.
• Have a new feature idea or improvement suggestion? Use the forum to discuss it.
• File detailed issues on GitHub (what you did, and what the actual vs expected outcomes are).
• Read the Developer's Certificate of Origin if you want to send us code. It means you acknowledge that you can and do license your submissions under the license of the project.
• Feel free to fork this repository and make your desired changes.

Please see our How to contribute section for more information on how to contribute to the ElkArte Project.

Class / Method / Function documentation

ElkArte utilizes source code documentation blocks to provide descriptions for all of its classes, methods and functions. This API Documentation is available online for viewing and searching.

Site and IRC

Join us on IRC, on #elkarte channel on freenode.

Project site: www.elkarte.net

addons's Issues

Details page should show ElkArte version compatibility

master branch?

Am I wrong or the master branch can go?

Search "no results" without styles

I searched around the code, but I couldn't figure out where this is generated... 😊

When the search doesn't find anything, the "no results" is not wrapped by the li tag and for that there is no style associated.

Suggestion: Use SPDX instead of OSI

Even assuming that ElkArte add-ons are to be considered derivative work, the current recommendation of using OSI-approved licenses is too narrow, because the list is rather short.

I would recommend that the SPDX License List is used as a valid source instead. That would have two important improvements:

1. The list is much longer (even including the WTFPL ;-)),
2. there are unique identifiers assigned with each license, so one wouldn't have to guess anymore.

Example from the existing code:

{% when 'BSD' or 'BSD3' %}

Can you guess which "BSD license" the BSD license is?

Solvable with SPDX!

Change addons URL?

Would it be possible to have addons URL not containing the publication date?
It would make easier to keep track of URLs posted around. At the moment, any time someone updates the entry, the URL is changed and old references become 404s.

If I got it right, the date is necessary to present newer and last updated on top, maybe have a "static" one in addition to?

Category titles

This is a kind of shared issue between the addons server and Elk, but I'm filling in here because if there is anything to fix I feel it should start here.

In the server page in Elk, the category "title" is picked as the category... "shortname" (?) ucwords'ed:
https://github.com/elkarte/Elkarte/blob/development/sources/admin/PackageServers.controller.php#L180
and the name comes from the json at:
http://addons.elkarte.net/package.json
if I'm not wrong, generated with the template:
https://github.com/elkarte/addons/blob/gh-pages/package.json

Lurking here around, I noticed we have what I'd call a "full name" for the categories as well:
https://github.com/elkarte/addons/blob/gh-pages/categories/enhancement.html#L3 (the title parameter)

Do you think it would be possible to use that "full name" parameter as category name in the package manager page?

/me hopes something in this issue does make some sense... lol

ETA: for completeness sake, I was asked where the name comes from and noticed this possibility for improvement.

License/s

Is it worth have a license in the root and then say that the valid license is the one set by the authors in the addons directory?

I would remove the one in the root of the repo.