Speedy PHP Framework comes in a ready to run format but you still might need some tweaks for application which can be done in the config file located at App/config.php.
The config file contains an array of values that can be accessed project wide using the $_ENV super global variable.
More keys can be added to the config which you wish to access site wide.
The pre-defined variables are:
'app_key' => '$omeRadomKeyofTHEapplication' -> Used to encrypt api keys and other secure resources
'debug' => true, -> Defines the debug mode of the application
'timezone' => 'Asia/Kolkata', -> Sets the default timezone of the application
'cors' => '*', -> Sets the Cross-Origin Resource Sharing (CORS) Header
'DB_TYPE' => 'mysql', -> DB Type (Fallback, Do not change).
'DB_ADO_DRIVER' => 'mysqli', -> ADOBD DAL driver
'DB_SERVER' => 'localhost', -> Database Host
'DB_PORT' => 3306, -> Database Port
'DB_USER' => 'root', -> Database username
'DB_PASSWORD' => 'password', -> Password to access the database
'DB_NAME' => 'api', -> Database name to be used.
'DB_CHARSET' => 'utf8', -> Database default character set.
'DB_FETCH_MODE' => PDO::FETCH_ASSOC, -> Database PDO Fetch Mode
'session_prefix' => 'spf_', -> Application Cookies prefix
'session_life' => 604800, -> Lifetime of application sessions
'cache_template' => true, -> Whether to allow Twig Template Caching
'error_pages' => [-> Error views to be loaded (Remember not to add the extension i.e. vu.php).
'404' => '404'
]


To make your work more efficient Speedy provides you with a handy tools called creator which handles several common tasks for you.
creator is a php file which needs to be run from the command line using the following syntax:

• init:app
Used to initialize the application after installation. This command is automatically run when you create the project using composer.
Syntax: php creator init:app
• create:controller
This command creates controllers for your application of the specified name.
Syntax: php creator create:controller <CONTROLLER_NAME>
• db:update
This command is used to execute the query files contained in the DBTables directory. It optionally accepts the name of the table to be executed which is also th name of the file without the .sql extension. If the name is provided then that specific file is executed onto the database, else all un-migrated files are executed. Syntax: php creator db:update [optional table_name] This updates the only table name provided. If you want to execute all un-updated files in the Directory run the following command php creator db:update
Important
It is important that the file name should be table_<table_name>.sql and the file should only contain valid SQL and when running the command only the table name should be provided not the full name.
• run:server
Speedy comes with a built in development server to test and develop your application. Your can run your application even if you do not have a web server like Apache or Nginx. By default this command runs the server on the port 9090. You can optionally provide a port number on which you wish to run the server. Syntax: php creator run:server [optional port number] To stop the server press [ctrl]+c.
• cache:clear
This command is used to clear your application view and other caches. If you are making a change in your views and it is not being reflected. It is a good idea to run this command. If you have set your debug mode to true the view cache will automatically be cleared. Syntax: php creator cache:clear

For a user to access pages of your web application you need to define routes.
Speedy provides a simple routing method of defining these routes, the routing file is App/Routes.php

To define a route you need to edit the App/Routes.php file and add the route following the syntax given below:

• GET
• POST
• PUT
• PATCH
• DELETE
• HEAD
• OPTIONS
• ANY -> Accepts all request methods