/pagekit

Pagekit CMS

Primary LanguagePHPMIT LicenseMIT

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.

Fresh packages coming soon.

Install Pagekit from Source

Make sure you have the following tools installed: Composer, npm, Bower, Webpack, Gulp.

Clone the repository.

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

Navigate to the cloned directory and install PHP dependencies.

composer install

Install Node dependencies and build the front-end components:

npm install

To watch for local LESS asset changes, run gulp watch.

To watch for JS module changes, run webpack --watch.

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

Stay up to date

If you've set up Pagekit from source, run these commands to get new commits and to rebuild everything you need.

git pull
composer update
npm install
bower update
gulp
webpack

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.

Credits

Half Dome Photo by Brendan Lynch / CC BY