cradlephp/cradle-website

Common Schemas and front end for websites

2.3.0 2019-09-06 08:07 UTC

Requires

• cradlephp/cradle-admin: ~2.2.0
• cradlephp/storm: ~2.2.0
• elasticsearch/elasticsearch: 2.2.2
• erusev/parsedown: 1.7.1
• predis/predis: 1.1.1

Requires (Dev)

• php-coveralls/php-coveralls: ~2.1.0
• phpunit/phpunit: 7.0.2
• squizlabs/php_codesniffer: 3.2.3

MIT

• Christian Blanquera

• cradle
• cradlephp

README

Common Schemas and front end for websites. Schemas included

• Layout
  • Page - Create static or dynamic pages, trigger an event and customize the template in the admin. Pages are designed for simple request and response outputs and are designed to work in collaboration with code via events. Pages are also designed to easily set up SEO per page, build sitemaps, and RSS feeds.
  • Block - Blocks are used to handle separate logic that needs to be outputted in pages. Like pages, blocks also can trigger events and can have a customized template defined in the admin. Usage {{{block 'block-name'}}}.
• Content
  • Category - General category definition that can be used with other schemas
  • File - General file repository definition that can be used with other schemas
  • Post - An article post schema, with front end support used for a general blog

Install

This package is experimental and is still in development. To try out this package you need to manually copy the schemas to your /[project]/config/schema folder, install each schema one by one and run the SQL scripts in package/fixtures.

$ composer require cradlephp/cradle-website

Contributing to Cradle PHP

Thank you for considering to contribute to Cradle PHP.

Please DO NOT create issues in this repository. The official issue tracker is located @ https://github.com/CradlePHP/cradle/issues . Any issues created here will most likely be ignored.

Please be aware that master branch contains all edge releases of the current version. Please check the version you are working with and find the corresponding branch. For example v1.1.1 can be in the 1.1 branch.

Bug fixes will be reviewed as soon as possible. Minor features will also be considered, but give me time to review it and get back to you. Major features will only be considered on the master branch.

1. Fork the Repository.
2. Fire up your local terminal and switch to the version you would like to contribute to.
3. Make your changes.
4. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")

Making pull requests

1. Please ensure to run phpunit and phpcs before making a pull request.
2. Push your code to your remote forked version.
3. Go back to your forked version on GitHub and submit a pull request.
4. All pull requests will be passed to Travis CI to be tested. Also note that Coveralls is also used to analyze the coverage of your contribution.