https://github.com/kladskull/deviant
Deviant is a simple extensible PHP Boilerplate/Mini-framework.
https://github.com/kladskull/deviant
boilerplate framework php php-boilerplate php-framework
Last synced: 12 months ago
JSON representation
Deviant is a simple extensible PHP Boilerplate/Mini-framework.
- Host: GitHub
- URL: https://github.com/kladskull/deviant
- Owner: kladskull
- License: mit
- Created: 2017-09-28T15:11:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-29T18:12:27.000Z (over 3 years ago)
- Last Synced: 2025-03-28T14:11:41.994Z (12 months ago)
- Topics: boilerplate, framework, php, php-boilerplate, php-framework
- Language: PHP
- Homepage:
- Size: 405 KB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Deviant - Simple, Extensible Boilerplate/Mini-Framework
## About Deviant
Deviant is a PHP Boilerplate/mini-framework that has been designed
from the ground up to be quick and responsive.
## What to Expect
Because this is a newer project, expect that it may not be
mature enough to be used in a production environment.
You'll also notice the lack of documentation, which is being
worked on.
## Requirements
- Minimum of PHP 7.1
- MariaDB or MySQL Server
- Composer
## Installation
Ensure that you have composer installed, clone the repository, and
run `composer install`. To run your project locally, use `composer start`. All of your templates go in
/app/templates/ and all of your pages go into /app/scripts. Currently
we only support Smarty. If you have any issues, take a loot at some of
the base project, specifically `/app/controllers/login.php' and its template
'/app/templates/login.tpl'.
Install composer, and run `composer install` in the composer directory.
Install apache2 modules `header` and `rewrite`.
You will also need to copy `/env_example` to `/.env` and modify the
contents to your server configuration.
Be sure to add any includes to the bootstrap in `/app/bootstrap.php`. This
will defintely change going forward, so make sure to heavily comment.
The schema can be found in /app/database/ - run it on your MySQL Database.
Make sure you run the following command as it creates missing directories
and ensures that they have proper permissions: `/fix_perms.sh`.
## Post Installation
Visit yoursite.com/signup - this will allow you to become an
administrator. Any registrations that follow will have to be `unlocked`
in the administrator/users menu. Currently any sign-ups have to be approved
by the administrator. This will be a config option going forward,
but for now, its just the way it is.
## Contributing
Thank-you for considering this. There have been no guides created
as of yet, but if you're serious, please email me at
mikecurry74@gmail.com (or just start contributing!)
## Security Vulnerabilities
If you discover a security vulnerability within PSF, please send
an e-mail to Mike Curry at mikecurry74@gmail.com. All security
vulnerabilities will be promptly addressed.
## Responsibility
You are responsible for your website, and take all risk using this
framework. We will not be held responsible for any breaches or
lack of security functionality coming out of the use of this framework,
even if we know of such vulnerability. Everything is risky in WWW!
## License
Deviant is open-sourced software licensed under the
[MIT license](http://opensource.org/licenses/MIT).