piko/project

Application skeletton for a Piko framework based project.

v2.1 2022-11-13 22:05 UTC

This package is auto-updated.

Last update: 2024-04-14 01:41:34 UTC


README

A basic Skeletton to build a Piko framework based application.

Install via composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

You can then install this project template using the following command:

composer create-project piko/project yourproject

Run using the PHP built-in web server

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 :

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 integration
  • Simple user authentication
  • Contact form

Documentation

https://piko-framework.github.io/