README

INTRODUCTION

Flextype is Modern Open Source Flat Files Content Management System. Building this Content Management System, we focused on simplicity. To achieve this, we implemented a simple but powerful API's.

With Flextype, you are in complete control. Design your data structure the way you want. Update and share your data with others and teams using version control. Flextype does not require MySQL database, because all the data are collected in a simple files. Perfect portability when changing your hosting provider. Just copy all the files from one server to another.

The underlying architecture of Flextype is built using well established and best-in-class technologies. This is to ensure that Flextype is simple to use and easy to extend.

REQUIREMENTS

SYSTEM REQUIREMENTS

Make sure your server meets the following requirements.

Webserver (Apache, Nginx, etc.)
PHP 8.1 or higher

PHP EXTENSIONS

Flextype needs the following PHP extensions to be enabled:

PHP mbstring module for full UTF-8 support.
PHP gd or ImageMagick module for image processing.
PHP json module for JSON manipulation.
PHP Fileinfo
PHP SPL
PHP DOM

Although it is optional, we strongly recommend enabling the following PHP extensions: APC, APCu, XCache, Memcached, or Redis for better performance.

QUICK INSTALLATION

Download the latest version of Flextype.
Unzip the contents to a new folder on your local computer, and upload to your webhost using the (S)FTP client of your choice. After you’ve done this, create directory project and be sure to chmod the following directory to 755 (or 777), so it is readable and writable by Flextype.

read the documentation

COMMUNITY

Flextype is open source, community driven project, and maintained by community!

Github

You may use GitHub Discussions to start discussion about core, plugin and themes development or If you want to report a bug, you can use the GitHub Issues.

Twitter

Follow Flextype on Twitter to get real-time news regarding the development and all events we are attending.

SUPPORTING Flextype

Flextype is an open source project and community contributions are essential to its growing and success.

Contributing to the Flextype is easy and you can give as little or as much time as you want.

FINANCIAL SUPPORT

Flextype is an MIT-licensed open source project and completely free to use.

However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.

You can support it's ongoing development by being a project supporter:

Visit Supporters page

PLATFORM CONTRIBUTIONS

Another excellent way to help out is by contributing your time or services.

BUG REPORTING

We are using GitHub Issues to manage our public bugs. We keep a close eye on this so before filing a new issue, try to make sure the problem does not already exist.

PULL REQUESTS

We actively welcome your pull requests!

If you need help with Git or our workflow, please ask in our community chat. We want your contributions even if you're just learning Git. Our maintainers are happy to help!

DOCS

You may help us to create amazing knowledge base for Flextype. Fix spelling, add code examples, help organize, write new articles, and etc...

flextype / flextype

Maintainers

Details