kytschi/kytschbasic

kytschBASIC is a PHP module written in Zephir-lang that will allow you to write BASIC code to render flat html. kytschBASIC is heavily inspired by Amiga BASIC a language I loved on a machine that is still amazing. https://kytschbasic.org

kytschBASIC

A PHP module written in Zephir that will allow you to run a version of BASIC language called kytschBASIC.

Installation

First thing you will need is to install Zephir

Now open your favourite terminal/console and clone the repo.

git clone https://github.com/kytschi/kytschBASIC.git

OR

git clone [email protected]:kytschi/kytschBASIC.git

Building the kytschBASIC PHP module.

cd kytschBASIC/kytschbasic
zephir build

Enable the kytschBASIC module. You can copy the sample ini file from the php folder in this repo. Remember to do this as root or a user with administrator permissions.

cp kytschBASIC/php/kytschBASIC.ini /etc/php/7.4/mods-available/

And don't forget to restart the PHP service.

Next setup an index.php on your webserver of choice and tell it to load the kytschBASIC compiler.

<?php
use KytschBASIC\Compiler;

(new Compiler(__DIR__ . '/../kytschbasic-config.json'))->run();

NOTICE we are loading in the configuration file. See configuration for more information on how to setup the configuration file.

For example website checkout the example folder in this repo.

Configuration

kytschBASIC configuration is handled via a JSON config file. From there you can define the database connection, the routes, etc. kytschBASIC example config

Database

The configuration for the database connection if needed. You can define more than one.

"db":[
	{
		"name":"kytschBASIC", 		<-- Name of the connection
		"type": "mysql", 		<-- Connection type
		"host": "127.0.0.1",		<-- Host IP
		"port": 3306,			<-- Host port
		"dbname": "kytschBASIC",	<-- Name of the database
		"user": "user",			<-- Username that has access
		"password": "password"		<-- Password of the user
	}
]

Routes

The routes allow you to define what kytschBASIC template is to be loaded for a specific URL or route.

"router":[
	{
		"url": "/",			<-- The URL/route that corresponds to the template.
		"template": "project/index.kb"	<-- The kytschBASIC template. Be sure to include its folder if its in one.
	},
	{
		"url": "/about",
		"template": "project/about.kb"
	},
	{
		"url": "/installation",
		"template": "project/installation.kb"
	},
	{
		"url": "/news",
		"template": "project/news.kb"
	}
]

More information

For more information and a to view the available command set please visit https://kytschbasic.org