Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viames/pair_boilerplate
Skeleton project to run Pair PHP framework in seconds
https://github.com/viames/pair_boilerplate
composer crud mvc mysql pair php skeleton
Last synced: 2 months ago
JSON representation
Skeleton project to run Pair PHP framework in seconds
- Host: GitHub
- URL: https://github.com/viames/pair_boilerplate
- Owner: viames
- License: mit
- Created: 2017-03-18T05:23:07.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T08:27:48.000Z (3 months ago)
- Last Synced: 2024-10-11T16:13:43.278Z (3 months ago)
- Topics: composer, crud, mvc, mysql, pair, php, skeleton
- Language: PHP
- Homepage:
- Size: 957 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pair boilerplate
a skeleton project to use [Pair PHP Framework](https://github.com/viames/pair) easily
[](https://packagist.org/packages/viames/pair_boilerplate)
[](https://packagist.org/packages/viames/pair_boilerplate)
[](https://packagist.org/packages/viames/pair_boilerplate)
[](https://packagist.org/packages/viames/pair_boilerplate)
[](https://packagist.org/packages/viames/pair_boilerplate)
This base project allows a fast start to develop small to medium PHP applications like CRM or web-portals.
With the addition of a few files more, here provided as sample, and an initial database structure, your web project will be up and running in a breeze.
## Features
This basic project manages users authentication, creates new custom ActiveRecord classes and [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) modules starting from a DB table by a magic module named `developer`, all thru a friendly route logic.
Also it acts as REST API server.
## Quick start
The [Installer](https://github.com/viames/pair_boilerplate/wiki/Installer) is used to configure the basic data of your web project. It starts automatically when the URL for the root folder is first launched, creates a custom [configuration](https://github.com/viames/pair/wiki/Configuration-file) file and auto-deletes after checking that everything is OK and that the installation was successful.
After the installation is completed, all the fields declared in the installer can subsequently be customized by modifying the `configuration` file except those related to the user created. For the latter, it is sufficient to modify it via the Users module.
## Create a new project
To start a web project with the Pair framework, this sequence is the suggested one:
#### 1. Install the pair_boilerplate
Use Composer to copy php files to a folder into your web server documents path:
```shell
composer create-project viames/pair_boilerplate my_project_name
```
#### 2. Run it by the browser
Launch the browser to the base address of the pair_boilerplate project to start the [Installer](https://github.com/viames/pair_boilerplate/wiki/Installer).
```shell
http://localhost/my_project_name
```
The project is ready to accept login and will let you manage users.
#### 3. Expand it according to your needs
Create additional InnoDB tables for database of your project and set the foreign keys properly, these are useful for getting the most out of [ActiveRecord](https://github.com/viames/pair/wiki/ActiveRecord). Then start the built-in [Developer module](https://github.com/viames/pair_boilerplate/wiki/Developer), which will allow you to create a complete CRUD and class module for each of your custom tables.
#### 4. Customize the template
Your project deserves a unique aspect, so proceed to customize the existing template or install a new template plugin via the built-in `Template` module.
---
### Contributing
If you would like to contribute to this project, please feel free to submit a pull request.
### License
MIT