README

Platine Starter is a Platine Framework based simple starter project. Most of the commonly needed features of an application like Authentication, Authorisation, User and Role management, Application Backend, are available here. It is modular, so you may use this project as a base and build your own application.
The Platine Starter comes with several features which are the most common in almost all applications. It is a template project which means it is intended to build in a way that it can be used for other projects. It is a modular application, and some modules are installed by default. It will be helpful to use it as a base for future applications.

Requirements

Any web server (Apache, nginx, lighttp, etc.)
PHP >= 7.4, PHP 8

Installation

Follow the steps mentioned below to install and run the project.

Create project

composer create-project platine-php/starter

Create .env file by copying the .env.example. You may use the command to do that

cp .env.example .env

Update the database, application URL and others information in .env file.

# Application
PL_APP_URL=http://localhost/starter/public/

# Database
PL_DB_DRIVER=mysql
PL_DB_NAME=db_platine_starter
PL_DB_HOST=127.0.0.1
PL_DB_PORT=3306
PL_DB_USER=root
PL_DB_PASSWORD=

Run the command to execute migration

php platine migration:init
php platine migration:migrate

Run the command to insert demo data

php platine seed:exec

You may create a virtualhost entry to access the application or run php platine server from the project root and visit http://127.0.0.1:8080.

Demo

Use the following account credentials to access the application backend:

Username: admin
Password: admin

License

MIT License See LICENSE.MD

Resources

Documentation

platine-php / starter

Maintainers

Details