astrotomic / stancy Goto Github PK

View Code? Open in Web Editor NEW

36.0 3.0 5.0 413 KB

This package aims to provide the most common and flexible CMS features to your Laravel project.

Home Page: https://docs.astrotomic.info/stancy

License: MIT License

PHP 99.88% HTML 0.09% Blade 0.03%

laravel cms static-site-generator file-based file-based-cms stancy treeware hacktoberfest

stancy's Introduction

You search for a CMS that only extends your loved Laravel framework? Here it is.

This package aims to provide the most common (and flexible) CMS features to your Laravel project. You can still use the frontend/template engine of your choice, use the scheduler/queue and receive POST requests.

Installation

composer require astrotomic/stancy

Demos

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Versioning

This package follows semantic versioning. Except the 0.x.y releases - these can introduce breaking changes in MINOR releases. So until a stable 1.x.y release is out you should use ~0.x.y (tilde version range) to fix to a MINOR release.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth

stancy's People

Stargazers

Watchers

Forkers

fossabot dannyvdsluijs phillipsb22 davidangel jeffersonsimaogoncalves

stancy's Issues

create a Laravel demo app

https://github.com/Astrotomic/stancy-laravel-demo

The demo app should show the basic features and in best case contain some integration tests using spatie/phpunit-snapshot-assertions. Only simple tests like: if I call this url/route I expect this response/html/snapshot.

relates to #8

create a Lumen demo app

https://github.com/Astrotomic/stancy-lumen-demo

relates to #9

generate forestry template by page data class

Generate a forestry.io template file by a page data class.

Add artisan make:page command

blocked by spatie/sheets#44

The package should provide a make:page command to simplify the process to create a new page.

The command should create the markdown file including YAML frontmatter head and an optional page data class.

The make command should only work if the default filesystem repository is used in the sheet collection
It should use the filesystem of the sheet repository
It should add the page data class to the YAML frontmatter
The default namespace for the page data class is App\Pages
It should accept sheet collection and path as arguments
The path should be possible with(out) extension
It should use stub files to generate the files

add custom exceptions

Add custom exception classes and implement ignition solutions, if possible.

Integrate spatie/laravel-export

Test with sitesauce

blocked by #18

A possible Integration with sitesauce should be tested. Optional some commands/events/triggers added to deploy after content change.

YAML front matter predefined variables

_view - the blade view
_pageData - the page data class
_sheets - a list of sheets that should be loaded

Test with netlify

blocked by #20

It should be tested if it's compatible with netlify. In best case including the redirects to backend to still support POST requests.

Write documentation

The whole documentation is missing and should be added.
It should cover basic usage but also have sections for every single component which describes it in detail for more advanced usage.

Every single improvement is welcome, so don't mind if you only add a single sentence or a whole section.
Atm the unittests are a good place to see some usage examples. But also the demo apps should get more content to look at.
If there are any questions I will ry to answer all of them.

Make page macroable

It should be possible to add macros to the page model.

Add PageFactory facade

Add a facade to access the \Astrotomic\Stancy\Factories\PageFactory via \Astrotomic\Stancy\Contracts\PageFactory service bindung.
The Facade should have all relevant methods as doc-tag for IDE support.
The naming of the facade should be PageFactory without any suffix.

Add nginx config for static serving

Add a default nginx config to serve static HTML files and Laravel app as fallback.

[Security] Workflow stale-issues.yml is using vulnerable action actions/stale

The workflow stale-issues.yml is referencing action actions/stale using references v2.0.0. However this reference is missing the commit af4072615903a8b031f986d25b1ae3bf45ec44d4 which may contain fix to the some vulnerability.
The vulnerability fix that is missing by actions version could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider to update the reference to the action.

Add caddy config for static serving

Add a default caddy config to serve static HTML files and Laravel app as fallback.