Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.18 KB

README.md

File metadata and controls

83 lines (56 loc) · 3.18 KB

Pagekit

Build Status Gitter

Pagekit is a modular and lightweight CMS built with Symfony components.

Getting started

Download the latest release and extract the archive, then copy the extracted folder to your webserver. Create a database for Pagekit. Run the Pagekit installation by accessing the URL where you uploaded the Pagekit files in a browser.

Developers

The develop version is undergoing heavy work at the moment. We invite you to join the fun and get the current version running on your system. Be aware that those versions are bleeding edge. They can and will break from one day to the next and are not suited for use in production.

First of all, install Composer.

If you haven't done so already, clone the Pagekit git repo.

git clone --branch develop git://github.com/pagekit/pagekit.git

To install the PHP dependencies of the project, navigate to the cloned directory and run the composer install command

composer install
#or if you don't have composer installed globally:
php path/to/composer.phar install

Pagekit uses npm for JavaScript dependencies. Make sure you also have Bower installed, which is called automatically during npm install.

npm install

Pagekit uses Gulp to compile the included LESS assets to CSS.

gulp compile

When these commands have finished, point your browser to the Pagekit URL on your web server and follow the installer.

To update Pagekit, you need to pull the Pagekit git repo and run the composer update command

git pull
composer update

You may also clear the tmp/cache folder.

CLI

Pagekit offers a set of commands to run usual tasks on the command line. You can see the available commands with

./pagekit --help

You can find further information about the command line tools in the pagekit documentation

Contributing

Pagekit follows the GitFlow branching model. The master branch always reflects a production-ready state while the latest development is taking place in the develop branch.

Each time you want to work on a fix or a new feature, create a new branch based on the develop branch: git checkout -b BRANCH_NAME develop. Only pull requests to the develop branch will be merged.

Versioning

Pagekit is maintained by using the Semantic Versioning Specification (SemVer).

Copyright and License

Copyright YOOtheme GmbH under the MIT license.