chassisphp/chassisphp

The ChassisPHP Framework - A Framework for CMS Site Development

v0.5.4-beta 2022-03-16 09:54 UTC

Requires

• php: ^7.1
• doctrine/cache: 1.11
• doctrine/orm: ^2.5
• league/container: ^3.3.0
• monolog/monolog: ^2.0
• nikic/fast-route: ^1.2
• phpmailer/phpmailer: ^6.5
• psr/http-message: ^1.0
• symfony/http-foundation: ^3.4.35
• symfony/http-kernel: ^3.3
• symfony/validator: ^3.3
• symfony/var-dumper: ^3.3
• symfony/yaml: ^3.3
• twig/twig: ^2.0
• vlucas/phpdotenv: ^2.4
• zendframework/zend-diactoros: ^1.6

Requires (Dev)

• guzzlehttp/guzzle: ^6.3
• phpunit/phpunit: ^6.3
• symfony/process: ^4.1

MIT

• Roger Creasy

• framework
• cms
• Chassis
• ChassisPHP

README

Beginning with version 0.5.0 There is a separation between the framework and developerland. We have developed a skeleton app which uses the new version. This skeleton is available in the repo ChassisPHP/ChassisPHP-skeleton.

ChassisPHP

Pronounced Cha-see
Yes, another PHP framework. The goal with ChassisPHP is to be a framework that simplifies the process of creating a brochure-type website. Be sure to visit our new site ChassisPHP.com It is very new and needs additional info. We would love your help wita the docs! See the repo at ChassisPHP-site repo. We are just getting started. This package is in beta. Use in production with caution

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. It's recommended that you use Composer to install ChassisPHP.

Prerequisites

• PHP >= 7.1
• Composer
• pdo_sqlite extension

Installing

• create a directory for your project
• from the directory above the project directory, run

  composer create-project -s dev rogercreasy/chassis-php [project directory name]

Configuration

The following steps will help you configure your install of ChassisPHP for the first time.

1. Copy the .env.example file to .env and ensure that it is readable by the web server process. The .env file is pre-populated with a standard configuration for the PDO SQLite extension (pdo_sqlite.)
2. Ensure that your sqlite database is upgraded by running the Doctrine ORM schema update. This can be handled in the following ways:

Unix: php vendor/bin/doctrine orm:schema-tool:update

Windows: php vendor\doctrine\orm\bin\doctrine orm:schema-tool:update or vendor\bin\doctrine.bat orm:schema-tool:update

1. Attempt to login to the /backend/login page with the following credentials:

Username: admin@chassis.123

Password: admin

1. After logging in, navigate to /backend/users and select "Add User."
2. Specify your name, email, password, and ensure that you set the user level to 1. It is very important that you create your own unique administrator, so that others cannot circumvent the login protection and login using the default information.
3. Delete the default administrator by navigating back to /backend/users and selecting "Delete."

Testing

To run a test, use:

$ phpunit

if your environment isn't set up yet, find phpunit at .\vendor\bin\phpunit

Style, etc.

We follow PSR-2 for coding style, PSR-4 autoloading, PSR-7 for messaging, and PSR-11 for containers. We also believe in the use of the Oxford comma (see the above line). :-)

ChassisPHP is not bound to any particular component. Whenever possible component use is written such that it can be replaced with a component of the developer's choosing. i.e. the PHP League Container is default. However, if the developer prefers Pimple, she or he can use it.

Contributing

If you are new to the ChassisPHP project, check out our newbie guide - Contribution guidelines for this project. Also be sure to read through our Code of Conduct

We REALLY do want your help. ChassisPHP has grown into a project with real potential! We try to be a helpful, welcoming, and nurturing community. Please look at the code, try it out, and let us know what you want changed. Make a pull request for the change, if you want.

1. Comment on the issue on which you wish to work (If the issue doesn't exist, create it)
2. Fork it!
3. Clone the repo: git clone https://github.com/RogerCreasy/ChassisPHP.git
4. Switch to the current active development branch - currently 0.1.x
5. Create your feature branch: git checkout -b my-new-feature
6. Commit your changes: git commit -am 'Add some feature'
7. Push to the branch: git push origin my-new-feature
8. Submit a pull request :D
9. Make any requested changes
10. Profit

Author

ChassisPHP has a quickly growing community of contributors. If you want your name added to that list of contributors, see the "Contributing" section above.
Roger Creasy is the maintainer of the ChassisPHP project, and is its founder.

License

The MIT License (MIT)