Read Me

Setup instructions
==================

------------------
-- Installation --
------------------
1. Copy the japper-php folder to a location preferably not under the webroot.
2. Create your site's root directory, with write access.

   Use the sample site as a template or set up the following structure:

	/<site directory
		/modules
			/main
				module.class.php
		index.php

	File contents:
	-------------

		index.php:
		----------
			<?php require_once('/path/to/japper-php/bootstrap.php'); ?>

		module.class.php:
		-----------------
			<?php
			use japper\org\app\connectors\module as moduleConnector;

			class module extends moduleConnector {

				function main() {
					echo 'this is a simple module';
				}

			}
			?>

3. Pull up your site in a browser.  Check for any errors related to saving files.
4. Some .ini and .sqlite3 files should now be in your site's root directory.
5. Edit the config.ini file to set some basic information about site.
6. To enable friendly URLs:
   
   On Apache:
		An .htaccess file should have been written along with the ini files, 
        if that file did not already exist.  If you have an existing .htaccess 
		file, append the following:

		RewriteEngine on
		
		RewriteBase <replace with the proper path from the domain to your site URL.  example, if your site is www.test.com/site1, then this would be /site1.  if it was just www.test.com, then this would be />
		
		RewriteRule ^(.*)\.ini$ index.php
		RewriteCond %{HTTPS} !=on
		RewriteCond %{REQUEST_FILENAME} !-f
		RewriteRule ^(.+)$ index.php?404;http://%{HTTP_HOST}%{REQUEST_URI} [QSA]
		RewriteCond %{HTTPS} =on
		RewriteCond %{REQUEST_FILENAME} !-f
		RewriteRule ^(.+)$ index.php?404;https://%{HTTP_HOST}%{REQUEST_URI} [QSA]

   On IIS:
		Open up the IIS Admin.  Navigate to the folder for your site, and view
		the properties.  Refer to the IIS Admin documentation to change the 404
		error page to be /path/to/site/index.php

   After setting up the webserver, open up the config.ini, and under the
   [application] section, add the following declaration:
   
		friendly_urls = 1