Pckg Documentation
Pckg Documentation
  • About
  • Concept
  • Start
  • Deployment
  • Tests
  • Ecosystem
    • Docker images
    • Skeleton
  • Core packages
    • Auth
    • Cache
    • Collection
    • Concept
    • Database
      • Repository
        • Driver
      • Entity
        • Relations
        • Query
      • Record
        • Fields
        • Model
      • Events
      • Extensions
    • Framework
      • Environment
        • Console
        • Development
        • Production
        • Test
      • Application
      • Providers
      • Config
      • Router
      • Request
      • Response
      • Controller
        • Middleware
        • Afterware
      • View
      • Events
      • Exception
    • Generic
      • Dynamic
      • Generic
      • Maestro
    • Htmlbuilder
      • Elements
        • Form
        • Fields
      • Datasources
      • Validators
      • Decorators
    • Locale
    • Mail
      • Drivers
      • Template
      • Mail
    • Manager
      • Asset manager
      • SEO manager
      • Meta manager
      • Upload manager
      • Vue manager
      • Job manager
      • Locale manager
      • Page manager
    • Migrator
      • Migrations
      • Fields
    • Queue
      • Driver
      • Publisher
      • Subscriber
    • Storage
      • Driver
      • Media
    • Translator
  • More packages
    • API
    • HTTP QL
      • Read
      • Write
      • Uploads
    • Task
      • Async
    • Websocket
      • Server
      • Client
  • Frontend
    • Helpers JS
    • Helpers CSS
  • Extras
    • Parser
    • Payment
    • Tenant
Powered by GitBook
On this page
  • About Pckg
  • Features
  • Installation
  • Directory structure
  • Concept
  • Versioning

Was this helpful?

About

NextConcept

Last updated 1 year ago

Was this helpful?

About Pckg

Pckg framework is perfect for building everything. Really. You can build simple website, api webservice, shop or anything that needs to be accessable from internet.

Features

  • PHP 8.0 Framework with ORM, Migrations, Auth, Queue and I18n modules on the backend -

  • Webpack with VueJS ecosystem integration on the frontend - and

  • Plug'n'play Docker images for Dev and Prod environments -

  • CI & CD pipelines (Github Workflows) - ./github/workflows/

  • PHP Cloc, Stan, CS, Codeception and Mocha - composer.json and package.json

Installation

The shortest, quickes and easiest way to start with development in pckg enviroment is installation of

$ composer create-project pckg/skeleton . dev-master --prefer-dist

You should also install frontend dependencies.

npm install
# or
pnpm i
# or
yarn install

All empty directories and symlinks are then created with internal command.

$ php console project:init

You can start with development after app creation.

$ php console app:create

Optionally, you can initialize git repository, remote and commit initial changes.

$ git init .
$ git remote add origin git@github.com:foo/bar.git
$ commit -m “Initial commit”

Directory structure

  • vendor, components and node_modules - dependency managers directories

  • config - root project configuration

  • www - public directory

  • storage - directory for framework, cache, uploads, tmp and other files

  • app/X/config - app configuration

  • app/X/src - app source files

Concept

Versioning

  • master - PHP v7.4

  • next-8.0 - PHP v8.0

  • next-8.1 - PHP v8.1

  • next-8.2 - PHP v8.2

  • main - PHP v8.3

  • next - PHP v9.0

Now that you've created your app, continue with the section to learn more about the concepts and request lifecycle.

pckg/framework
pckg-app/frontend
pckg-app/frontend-dev
pckg/docker-images
skeleton
Concept