The Mjolnir Library

Getting Started

Basic directions and overview of how to get the library and start an application.

The library has been designed to manage large projects. We provide some compatibility with services that only offer ftp access, but in general the minimum, as far as basic web apps go, stands at a basic server with php where you have ssh and git access along with a place outside on the server's public section where you can securily place the system and private files.

We do not support or recommend placing system files in the servers public section.

Requirements

Additional PHP extentions are specified by system tools. We avoid mentioning them here since they are dependent on the modules and features you have loaded/enabled. Information on required settings are also available though system tools provided with the distribution.

Web Applications

In addition to the above requirements:

  • a web server (apache, nginx, etc)
  • MySQL-compatible Database server (optional)

If you are using Windows for development we recomend using Uniform Server, Winginx or EasyPHP, whichever fits your needs best.

Starting From A Template

We offer a basic template from which to start and also pull changes. You may use any other template, including creating your own; we are a library, the project files and structure are whatever you want them to be. The template we recomend can be found at https://github.com/ibidem/mjolnir-template-app

Detailed instructions are available at the given link. When using 3rd party templates we recomend using their installation instructions.

Brief overview of getting the files

cd /path/to/secure/location/
git clone https://github.com/ibidem/mjolnir-template-app.git your-project/
cd your-project/
git remote rename origin mjolnir
bin/vendor/install

Starting From A Tutorial

A tutorial is provided with the documentation. The tutorial explains various features and how to setup a project from scratch.

For an online version of the tutorial please refer to the docs section.

After following the brief commands illustrated in the "Starting From A Template" section you may generate the documentation by running ./order librarian --manual. A pdf and html version will be generated based on the modules you have loaded on your project root. Since it is dependent on your modules the documentation may include information provided by 3rd parties pertaining to your setup.

Starting From Scratch

If you are confident in your ability and understanding of how a web application works and wish to create your own special brew feel free to include the library and creating the entire application and structure from scratch.

For compatibility reasons (mainly dependency resolution) we recommend using composer when pulling the library in. The following is the minimal composer.json for pulling in the complete library:

{
	"minimum-stability": "dev",

	"require": {

		"php" : ">=5.4.10",

		"mjolnir/cfs"        : "dev-liquid/2.x",
		"mjolnir/base"       : "dev-liquid/2.x",
		"mjolnir/foundation" : "dev-liquid/2.x",
		"mjolnir/html"       : "dev-liquid/2.x",
		"mjolnir/access"     : "dev-liquid/2.x",
		"mjolnir/cache"      : "dev-liquid/2.x",
		"mjolnir/database"   : "dev-liquid/2.x",
		"mjolnir/backend"    : "dev-liquid/2.x",
		"mjolnir/theme"      : "dev-liquid/2.x",
		"mjolnir/types"      : "dev-liquid/2.x",
		"mjolnir/librarian"  : "dev-liquid/2.x",
		"mjolnir/legacy"     : "dev-liquid/2.x",
		"mjolnir/profile"    : "dev-liquid/2.x"

	}
}