selenesoftware/staticsite

There is no license information available for the latest version (0.0.4) of this package.

Maintainers

Details

github.com/SeleneSoftware/seleneStaticLib

Source

Issues

Installs: 32

Dependents: 1

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 0

Open Issues: 3

0.0.4 2019-10-03 02:45 UTC

Requires

Unknown License 859c9999c1178f40d28849fa8c2127eaca5353f4

This package is auto-updated.

Last update: 2024-04-29 04:00:17 UTC

README

A rather small static site builder built from Twig and Markdown that isn't blog centric.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Composer npm/Yarn PHP 7.2+

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

composer create-project selenesoftware/seleneSite

Running the tests

Explain how to run the automated tests for this system I don't have tests for this. It is so small, tests would seem larger than the actual code. Don't want that.

Code Styles

The code for the actuall builder and the skeleton are sniffed by the PHP CS Fixer (friendsofphp/php-cs-fixer). There is a .php_cs.dist file that contains the rules usually run by Selene Software. Feel free to adjust it to your own style guidelines.

php-cs-fixer fix

Deployment

Once you run bin/app.php there will be files created in the 'web' directory. Then run npm run build and you have production ready files. Drop everything in the 'web' directory into your production environment.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

When submitting a pull request, please make sure you are submitting to the feature branch with the next version number. If your pull request contains only documentation, please feel free to pull against master.

When submitting, please update the Authors section below.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository. We also try to keep the skeleton the same version as the lib.

Upgrading

We try to modify the skeleton as little as possible between versions, as plugins are built in the Application file. But to upgrade the library, just update composer:

composer update

Authors

  • Jason Marshall - Initial work - psion

License

This project is licensed under the Apache License - see the LICENSE-2.0.md file for details