Getting Started

  1. Requirement
  2. Installation
  3. Configuration
  4. First steps

Requirement

Firstly, you need a simple server running PHP, MySQL and Apache.
A local server built with Wamp, Mamp or Xamp is perfectly suited.

  • PHP (min 5.4)
  • MySQL (min 2.2)
  • Apache

Installation

Packaged version : the easy way


  • Download the zip file

    You can simply click on this link.

  • Unzip it in your apache web directory

    Could be located at MAMP/htdocs/ on MacOS or wamp/www/ on Windows

  • Move to the page check.php with your web browser

    Could be : http://localhost/Keosu/web/install/check.php

  • Test it!

    Move to your web/app_dev.php with your web browser (ie http://localhost/Keosu/web/app_dev.php)

    Login: admin

    Password: YouKnowIt


  • From sources : Nerds only!


    • Clone project in your apache web directory

      git clone https://github.com/keosuofficial/keosu.git

    • Download composer.phar

      curl -s https://getcomposer.org/installer | php

      MacOS | Windows

      php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));"

    • Then run

      php composer.phar update

      and

      php app/console assetic:dump

    • Move to the page check.php with your web browser

      Could be : http://localhost/Keosu/web/install/check.php

    • Test it!

      Move to your web/app_dev.php with your web browser (ie http://localhost/Keosu/web/app_dev.php)

      Login: admin

      Password: YouKnowIt

Configuration


  • Create an app

    You can't go ahead without create an app from this page : web/app_dev.php/configuration/app/manage/add (ie http://localhost/Keosu/web/app_dev.php/configuration/app/manage/add)

    Screenshot : Edit App

    You need to fill the following fields in this way:

    Name: The name of your app

    Package name: Name your package (com.domain.appname), be careful to never forgot it

    Version: Initially 1.0.0, remember that you have to increase it for each new update before submitting to the stores

    Description: Write a short description of your app

    Theme: Select the theme of your application. Themes you create yourself will appear here.

    Other fields: Are not essential at the moment. You can now create your app with a click on the validate button

First steps


Before you begin, it is important to understand how Keosu works.

An application is composed of pages. These pages are divided into several areas that can accommodate gadgets. These will display the previously created contents.

Keosu's schema

Create pages

  • Add new page

    Go on Manage pages section from the lateral menu. Then, click on the Add new page button.

  • Name your page
  • Select a template

    Templates are divided in several aeras that can accomodate gadgets.
    You can easily create your own templates to answer your needs: Edit and create page templates.

  • The "is main" option

    This option define the main page. This is the first page of your app. An app must have only one main page. (It has the same role as the index.html page of a website).

    Screenshot : Edit a page
  • Validate

    You can now create your page with a click on the validate button. Pages created appear on the left menu, just below the PAGES section.

  • Edit or delete a page

    Go on the Manage Pages section. Then click on to edit page options. Or click on to delete a page.

Create content

Before adding content to your pages (trough gadgets), you have to create it.
To create content, just go on a content category, listed below the CONTENT section on the left menu. Then fill the fields to create some contents.

This section does not deal in detail with all types of content. To do this, refer to the Components part of this documentation.

Add gadget

Remember the illustration that describe how the CMS works. To display a content already created on a page, you have to use a gadget.
Note that some types of content doesn't need to be created upstream: some contents are created directly from the gadget.


  • Select an aera

    Gadgets are integrated into aeras. These aeras are defined by the page template you select when you created the page.

  • Select a gadget

    When aera selected, chose a gadget in the dropdown button linked to the aera.

    Screenshot : Page view
  • Edit the gadget

    Click on the blue button associated with the aera and its gadget.
    Fill the fields to complete the gadget edition. These fields will vary depending on the selected gadget.
    Like when creating a page, you sometimes have the option of choosing a gadget template. If needed, select a template.

    Concerning the shared with all pages option: Checking this option will incorporate the currently edited gadget on all pages of your application.

    Screenshot : Edit Gadget