README

This is a simple starter template for PHP projects. It provides a basic directory structure and configuration files to help you kickstart your PHP projects.

Features

Directory structure for organized development.
Autoloading setup for efficient class loading.
Easy pagination.
Easy validation.

Getting Started

Clone the Repository:

composer create-project xentixar/xen-php your_project_name

Navigate to the Project Directory:

cd your_project_name

Create a .env file:

cp .env.example .env

Navigate to the .env file and configure database
Navigate to the .env file and replace the 'APP_URI' value to your actual directory
Navigate to the .htaccess file and replace the 'RewriteBase' value to your actual directory
Run the project:

Start server and open browser and paste the following url :

localhost/your_directory

This should display a index.php page of src directory.

Directory Structure

your_project_name/
│
├── config/
| └── config.php
│ └── app.php
│ └── database.php
│ └── environment.php
│ └── pagination.php
│ └── rule.php
│ └── validation.php
│
├── public/
│ └── css
│ └── images
│ └── js
│
├── src/
│ └── index.php
│
├── vendor/
| └── composer
│ └── autoload.php
|
├── .env
├── .env.example
├── .gitignore
├── .htaccess
└── README.md

config/: Directory for the php configuration files.
public/: Directory for your assets.
src/: Directory for your PHP source files.
vendor/: Autoload files and composer dependencies if needed.
.env.example: Environment example file.
.gitignore: Git ignore file to exclude certain files/directories.
.htaccess: Htaccess file to redirect all requests to src directory.
README.md: Project documentation file.

Usage

Add Your Code:

Add your PHP code files inside the src/ directory.
Don't forget to include autoload.php file of vendor directory
To use pagination refer to the following link: Easy Pagination in PHP
To use validation refer to the following link: Easy Form Validation in PHP
Start Coding:

Start building your PHP project!

Contributing

Fork the repository.
Create a new branch: git checkout -b feature-name.
Commit your changes: git commit -m 'Add new feature'.
Push to the branch: git push origin feature-name.
Submit a pull request.

License

This project is licensed under the MIT License. Feel free to use and modify it according to your needs.

Happy coding!

xentixar / xen-php

Maintainers

Details