Download the PHP package noctis/kickstart-app without Composer

On this page you can find all versions of the php package noctis/kickstart-app. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package kickstart-app

Kickstart Application

Type Coverage Maintainability

What is it?

It's a skeleton/demo application part of the Kickstart project. The Kickstart project itself consists of two parts:

This application contains all the files the user should be able to modify in order to create their own Kickstart-based application.

What's it good for?

Kickstart was created to be a base for building micro and small PHP applications, either Web- or CLI-based.

OK, so how do I install this thing?

IMPORTANT: Kickstart has two major platform requirements:

To create a new project Kickstart-based project, run the following command in your CLI and let Composer do its thing:

IMPORTANT: replace app-name in the command above with whatever name you want. app-name is the name of the folder which will be created in the current working directory.

Developing Your App using Docker

Everything you should know about developing your Kickstart-based application can be found in this document.

OK, it installed. Now what?

Now you're free to modify/add files in the app-name folder (or whatever you changed it to) to build your application. I've included some demo/dummy files within the project to help you get started. You're free to remove those files altogether if you have no use for them. Instructions on how to do that can be found here.

IMPORTANT: If you're building a Web-based application, configure your WWW server to serve files from the public directory.

Application Components

A fresh Kickstart-based project consists of a couple of things:

Configuration

The project's configuration can be found in the .env file, in its root directory.

NEVER COMMIT THE .env FILE IN YOUR PROJECT - IT CONTAINS SENSITIVE INFORMATION WHICH MUST REMAIN PRIVATE!

This is how the .env file looks by default:

Here's a rundown of what each of these options mean:

APP_ENV

This option can take one of two values:

Setting it to prod changes three things:

Setting it to dev causes:

This option should be set to prod in production environments, and set to dev during development.

If you're making changes to your templates/views and they're not showing up in your browser - either clear the cache, by deleting the contents of the var/cache/templates directory, or set the APP_ENV option in .env to dev.

If you're making changes to service providers or classes' constructors (dependency injection) and the DIC (dependency injection container) fails to see them, clear the contents of the var/cache/container directory or set the APP_ENV option in .env file to dev

basehref

This is the URI of where the application is available from the browser. If it's available at, for example: localhost, the default value of / should be used. If it's available in a sub-directory, for example: localhost/kickstart, the basehref value should be set to /kickstart.

IMPORTANT: The barehref value in .env and the RewriteBase value in public/.htaccess file should always be the same! If those values are different, you'll be getting a lot of 404 errors.

For console commands the value of this parameter does not matter.

db_host, db_user, db_pass, db_name, db_port

Those 5 options are the database credentials:

HTTP Actions

You can read more about HTTP actions here.

Console Commands

You can read more about Console Commands here.

Database Repositories

Kickstart utilizes the Repository pattern, more or less. You call the appropriate methods on a repository object when you want to fetch or store something from/to the database.

By default, repository classes can be found in the src/Repository folder (the App\Repository namespace). All repositories which utilize the database connection extend the Noctis\KickStart\Repository\AbstractDatabaseRepository abstract class, which provides a protected field called $db representing the database connection.

Kickstart utilizes ParagonIE's EasyDB package for running queries against the database engine of your choice. EasyDB is a simple wrapper around PHP's PDO, which in my opinion is way easier to use than PDI itself. If you want to know more on why I chose EasyDB and not a different library, check the FAQ.

Service Providers

You can read more about Service Providers here.

Folders

You can read more about what each folder in your project's directory is here.

Updating

If you need to update the system part of your application, i.e. the noctis/kickstart package, just run:

Seeing as updating a Kickstart-based project is not as simple as that, I will do my best to update the noctis/kickstart-app package (this one) as rarely as possible. When I do release a new version of it and specific actions are needed to update the application part, you will find a version-specific guide inside the docs/upgrading folder of this project.

I will also keep the version numbers between both packages consistent. For example, when I make changes to the noctis/kickstart package that are incompatible with noctis/kickstart-app 2.x, I will release them as version 3.x of the former, along with an updated 3.x version of the latter. This way a composer update will not break your Kickstart application.

FAQ

Additional questions and answers relating to Kickstart can be found in the FAQ.

Recipes


All versions of kickstart-app with dependencies

PHP Build Version
Package Version
Requires php Version ~8.1.0
composer-runtime-api Version ^2
laminas/laminas-diactoros Version ^2.24
noctis/kickstart Version ~4.0.0
paragonie/easydb Version ^3.0
psr/container Version ^1.1|^2.0
psr/http-message Version ^1.0
psr/http-server-handler Version ^1.0
psr/http-server-middleware Version ^1.0
symfony/console Version ^6.4
vlucas/phpdotenv Version ^5.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package noctis/kickstart-app contains the following files

Loading the files please wait ....