Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A PHP MVC Framework for PHP Developers. For documentation and community, please visit:

README.mkd

inKWell (MVC Framework)

Preamble

inKWell is currently beta software, we will answer any questions you might have directly. E-mail info@dotink.org. Please check out our more extensive documentation on http://inkwell.dotink.org and feel free to leave comments or questions in-page using Disqus.

Licensing

If you wish to license this software under different terms and conditions than presented below, please e-mail: info@dotink.org

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Introduction

inKWell is an MVC framework built on Flourish (http://www.flourishlib.com) and Moor (http://www.github.com/jeffturcotte/moor). It is designed to be extremely lightweight and flexible. Unlike other frameworks nearly every aspect of it is designed to allow for easy overrides, including scaffolding.

The core framework follows a "KISS" philosophy. We begin by keeping core concepts and API to a minimum, providing only a handful of classes in that comprise the base framework and the 90% use case.

If you'd like to learn how to use inKWell or a bit more about its design, you can visit our documentation site at http://inkwell.dotink.org

Installation

Installing inKWell should be pretty straightfoward. Git is the recommended installation medium. To install using Git simply type the following.

git clone --recursive git://github.com/dotink/inKWell.git <path_to_inkwell>

If you absolutely are unable to install via git, you can download requisite zip files from GitHub. You will need to download the following three repositories as zip files:

[1] http://github.com/dotink/inkwell [2] http://github.com/dotink/flourish [3] http://github.com/dotink/moor

Extract [1] into your desired installation path. Extract [2] into includes/lib/flourish inside the installation path. Extract [3] into incluces/lib/moor inside the installation path.

Apache with mod_rewrite

If you have .htaccess files enabled your site should already be working, 100% configured with clean URLs

Apache with CGI / No .htaccess

If you are using apache with CGI or you do not have access to .htaccess or it is not enabled, you can usually work with a local php.ini file instead. By default this file is located in .user.ini which is the default location for PHP's distributed CGI as of version 5.3.

Contact your hosting provider if you are on an earlier version and move it to their supported filepath. Rewrite rules, will likely not be supported unless they can add them to your virtual host configuration.

NGINX

NGINX works with PHP's distributed CGI or independently set up fastcgi install depending on the platform. For Windows users on 5.3 or later, the .user.ini file will suffice for PHP configuration.

For other users, reference the global php.ini file or contact your hosting provider for the needed location and move the .user.ini file to it.

Configuration of NGINX itself along with rewrite rules can be done by copying all or most of the directives from the provided nginx.conf.dist file and editing it where need be.

Something went wrong with that request. Please try again.