mirror of
https://github.com/flextype/flextype.git
synced 2025-08-24 05:43:10 +02:00
docs(core): update readme #273
This commit is contained in:
60
README.md
60
README.md
@@ -2,7 +2,6 @@
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/flextype/flextype/releases"><img alt="Version" src="https://img.shields.io/github/release/flextype/flextype.svg?label=version"></a> <a href="https://github.com/flextype/flextype"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a> <a href="https://github.com/flextype/flextype"><img src="https://img.shields.io/github/downloads/flextype/flextype/total.svg?colorB=blue" alt="Total downloads"></a> <a href="https://crowdin.com/project/flextype"><img src="https://d322cqt584bo4o.cloudfront.net/flextype/localized.svg" alt="Crowdin"></a> <a href="https://scrutinizer-ci.com/g/flextype/flextype?branch=master"><img src="https://img.shields.io/scrutinizer/g/flextype/flextype.svg?branch=master" alt="Quality Score"></a> <a href="https://discordapp.com/invite/CCKPKVG"><img src="https://img.shields.io/discord/423097982498635778.svg?logo=discord&colorB=728ADA&label=Discord%20Chat" alt="Discord"></a>
|
||||
|
||||
</p>
|
||||
|
||||
<h1 align="center">Supporting Flextype</h1>
|
||||
@@ -13,12 +12,13 @@ However, the amount of effort needed to maintain and develop new features for th
|
||||
|
||||
- [Become a backer or sponsor on Patreon](https://www.patreon.com/awilum).
|
||||
- [One-time donation via PayPal, QIWI, Sberbank, Yandex](http://flextype.org/en/one-time-donation)
|
||||
- [Visit our Sponsors & Backers page](http://flextype.org/en/sponsors)
|
||||
|
||||
## INTRODUCTION
|
||||
|
||||
Flextype was **founded in March 2018** as lightweight alternative to other heavy and outdated CMS. Many people use complex solutions for simple pages, unnecessarily. Building this content management system, we focused on simplicity - even novice webmaster adapt his template and writes his own plugin. 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 account to another.
|
||||
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 account 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. Some of these key technologies include:
|
||||
|
||||
@@ -64,62 +64,14 @@ Mobile
|
||||
- iOS: Safari 9.1 or later
|
||||
- Android: Chrome 4.4 or later
|
||||
|
||||
## INSTALLATION
|
||||
|
||||
#### Using (S)FTP
|
||||
|
||||
[Download the latest version.](http://flextype.org/en/downloads)
|
||||
|
||||
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, be sure to chmod the following directories (with containing files) to 755(or 777), so they are readable and writable by Flextype:
|
||||
- `site/`
|
||||
|
||||
#### Using Composer
|
||||
|
||||
You can easily install Flextype with Composer.
|
||||
|
||||
```
|
||||
composer create-project flextype/flextype
|
||||
```
|
||||
|
||||
Install vendor libs for Flextype
|
||||
```
|
||||
composer install
|
||||
```
|
||||
|
||||
Install vendor libs for Default Theme
|
||||
|
||||
```
|
||||
cd site/themes/default
|
||||
npm install
|
||||
gulp
|
||||
```
|
||||
|
||||
Install vendor libs for Admin Panel plugin
|
||||
|
||||
```
|
||||
cd site/plugins/admin
|
||||
composer install
|
||||
npm install
|
||||
gulp
|
||||
```
|
||||
|
||||
Install vendor libs for Site plugin
|
||||
|
||||
```
|
||||
cd site/plugins/site
|
||||
composer install
|
||||
npm install
|
||||
gulp
|
||||
```
|
||||
|
||||
## COMMUNITY
|
||||
Flextype is open source, community driven project, and maintained by community!
|
||||
|
||||
- [Github Repository](https://github.com/flextype/flextype)
|
||||
- [Github](https://github.com/flextype)
|
||||
- [Discord](https://discord.gg/CCKPKVG)
|
||||
- [Twitter](https://twitter.com/getflextype)
|
||||
- [Forum](http://forum.flextype.org)
|
||||
- [Vkontakte](https://vk.com/flextype)
|
||||
- [Twitter](https://twitter.com/getflextype)
|
||||
|
||||
## CONTRIBUTE
|
||||
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.
|
||||
@@ -129,8 +81,8 @@ Flextype is an open source project and community contributions are essential to
|
||||
- Create a new theme.
|
||||
- Find and [report issues.](https://github.com/flextype/flextype/issues)
|
||||
- Link back to [Flextype](http://flextype.org).
|
||||
- [Donate to keep Flextype free.](http://flextype.org/en/about)
|
||||
- [Join Flextype International Translator Team](https://crowdin.com/project/flextype/invite)
|
||||
- [Donate to keep Flextype free.](http://flextype.org/en/sponsors)
|
||||
- [Join Flextype International Translator Team](http://flextype.org/en/international-translator-team)
|
||||
|
||||
## LICENSE
|
||||
[The MIT License (MIT)](https://github.com/flextype/flextype/blob/master/LICENSE.txt)
|
||||
|
Reference in New Issue
Block a user