infinitycube/quicksite

Slim 4 scaffolding for creating web applications. QuickSite creates a project structure with all essential packages pre-bundled.

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Language:HTML

Type:project

1.0.0 2020-04-09 03:16 UTC

This package is auto-updated.

Last update: 2020-09-09 04:27:01 UTC


README

QuickSite

A Slim 4 scaffolding for creating web applications at lightning speed.

QuickSite let you focus on the application and data structure. The scaffolding creates a project structure with an example application for your reference. A powerful view render engine, Twig helps you create awesome templates to render pages. It also has a Database Abstraction Layer (DABL) from Doctrine, your application need not directly interact with the database.

Prerequisites

For working with QuickSite scaffolding, you need the following

  • Skill: Object Oriented PHP
  • Skill: Twig Templating (if you use Twig)
  • Skill: Doctrine ORM (if you use Doctrine)
  • Composer installed on your machine
  • Docker (if you use Docker as your server stack)
  • MySQL (if you are not using Docker)
  • PHP 7.2 or greater

Setup Project

You can setup your Slim 4 project with QuickSite in a line of command in terminal / command-prompt.

$ composer create-project infinitycube/quicksite myproject

Go to your project directory

$ cd myproject

If you are have Docker installed and running, you may start your development server immediately by running.

$ docker-compose up

No Docker For those who don't have Docker, you must create a database and assign user access in your local mysql server. Then you need to edit the file ./app/settings.php look for db and give values to host dbname port user and password

Now you can start local server

$ composer start

Example Todo App

To make the example todo app working you need to run the migration bundled with this scaffolding.

For those who use Docker, you need to SSH into your docker container while it is running.

$ docker exec -it quick_site bash

Those who don't use Docker can skip the above step.

Now run the bundled migration.

$ php vendor/bin/doctrine-migrations migrations:migrate

You may now view the Todo app by pointing your browser to http://localhost:8080/todo/

Note

You may or may not require the pre-bundled packages within QuickSite. You may remove those packages if you know exactly what you are doing. You may find more about QuickSite in the QuickSite Documentation.