This is the ElkArte2 repository.

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

Initially based on the well known Simple Machines Forum (SMF), it began by an overall of the code in order to modernise, implement new features and make a forum software be 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 forum user.

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

Test ElkArte yourself by visiting 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 our features

• @Mentioning users including notifications
• Likes for posts and topics
• Drafts, including auto save
• OpenID 2.0
• Two built in modern, responsive themes
• Integrated video embedding for youtube, vimeo and dailymotion
• Drag and drop ordering in the administration interface
• Drag and drop file attachments
• Improved Anti Spam measures
• Improved password hashing using industry standards
• Bad Behaviour built in
• Automatic combining and minifying of JavaScript and CSS
• Posting by Email
• Ajax previews and responses throughout the user interface
• Utilizes jQuery and Font Awesome

Requirements

• PHP version 5.5 or newer
• MySQL 5 and newer OR PostgreSQL 8.3 and newer

On the client side, ElkArte will run & look good in just about any modern browser. Using IE?, well we support that too! You'll want IE8 or greater but some visual enhancements will not be present with IE versions < IE9

We've had a responsive theme from the start, so your forum will look great on your smartphone and tablet as well.

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 PHPMyAdmin
• Get the latest Install Package for ElkArte.
• Upload and extract OR Extract then upload 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 !

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, 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 ElkAte 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 teh 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 inline docblocks 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