https://github.com/piko-framework/piko-project
Basic skeletton for a Piko based project.
https://github.com/piko-framework/piko-project
Last synced: over 1 year ago
JSON representation
Basic skeletton for a Piko based project.
- Host: GitHub
- URL: https://github.com/piko-framework/piko-project
- Owner: piko-framework
- License: mit
- Created: 2019-02-06T17:48:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-13T22:07:35.000Z (over 3 years ago)
- Last Synced: 2025-02-04T04:26:02.386Z (over 1 year ago)
- Language: PHP
- Size: 1.54 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Piko project
A basic Skeletton to build a [Piko framework](https://piko-framework.github.io/) based application.
## Install via composer
If you do not have [Composer](http://getcomposer.org/), you may install it by following the instructions
at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).
You can then install this project template using the following command:
```bash
composer create-project piko/project yourproject
```
## Run using the PHP built-in web server
```bash
cd yourproject && php -S localhost:8080 -t web
```
## Environment file
There is a file named `env.php` at the root of the project. This file contains some environment variables :
```php
return [
'DEBUG' => '1',
'APP_ENV' => 'dev',
'APP_LANGUAGE' => 'en',
'SITE_EMAIL' => 'youremail@somehost.com',
]
```
Set `DEBUG = 0` and `APP_ENV = prod` when your project is ready for production.
## Project features
- [Bootstrap 5](https://getbootstrap.com/) integration
- Simple user authentication
- Contact form
## Documentation
[https://piko-framework.github.io/](https://piko-framework.github.io/)