- Check The Requirements
- Apply Database Changes
- Create The Config File
- Move Code Jetter Files To Your Host
- Include Autoloader In The Index
- Troubleshooting
- Where To Go From Here
Currently the main requirement for Code Jetter to run is PHP 5.6+. If your PHP version is not 5.6 or above that, an error will be thrown. The good news is that Code Jetter can run on a shared host.
If you need to use user component you must create all the required tables and also add an admin user to start with. This can be done by running CodeJetter/sql/initial.sql
in your MySQL database. Once it is finished you will see the following tables:
cj_admin_users
cj_group_member_user_xref
cj_member_groups
cj_member_users
Also an admin user has been added to cj_admin_users
Username: admin
Password: Admin1
As you see the default tables prefix is cj
which is specified in your config file (explained in the next step) with the key: tablePrefix
. This can be changed if you need to.
At this stage you need to change CodeJetter/core/Config.Template.php
as you need and then rename the file AND class names to Config.php
and Config
respectively. For the time being, you only need to worry about these config parameters:
Name | Type | Required | Description |
---|---|---|---|
URL | String | Yes | The domain url |
URI | String | Yes | Path to `CodeJetter` folder |
defaultDB | String | Yes | The domain url |
databases | Array | Yes | This includes the default database details |
Finally copy the CodeJetter/public
folder content to your host public directory (WWW
or public_html
), and CodeJetter
folder (excluding public
folder) to a non-public directory which should match the URI
value in the config file. Please note that the downloaded folder from GitHub is named code-jetter
, so you need to rename it to CodeJetter
.
Open public/index.php
and change the path to autoloader.php
based on the place that CodeJetter/autoloader.php
is located. Now if you check URL
in the browser you will see the welcome page.
- If there is any server error (error numbers starting with 5) first check
public/.htaccess
file. Then check to see if your host public path is set correctly. Finally you might need to check your server logs. - If the loaded page in the browser is blank you should enable PHP error reporting by changing
debug
totrue
forprod
environment in the config file. Once the issue is resolved make sure to changedebug
back tofalse
for security reasons. - You can also check
CodeJetter/temp/custom_error_log.log
to see if any error has been recorded
If you are ready to create your application using Code Jetter these are more detailed documentations that can help you: