edit

Quick Start

System Requirements

Webserver

  • NGINX, Apache (with mod rewrite) or equivalent server

PHP

  • PHP 5.4 or higher

Quick Installation

Via Composer

  • The Eridko framework utilizes Composer for installation and dependency management. If you have not install Composer, start by installing Composer.

After you installed Composer, you can run the following command in your terminal:

composer create-project erdiko/erdiko project-name

This command will download and install a fresh copy of Erdiko in a new project-name folder within your current directory. Then, you can move to next step to Setup web environment

Via Git

Download Erdiko

To download Erdiko from our Git repository, enter the following command in command prompt:

    git clone https://github.com/arroyolabs/erdiko

It will clone our Git repository to your local machine. Then, go to the Erdiko root folder and install Erdiko using Composer.

    composer install

Setup your environment

  1. Open the config file of your web server

  2. Change the webroot to [local erdiko code path]/public

  3. Create a folder named var in [local erdiko code path]/ and change the group of the /var folder to www-data using chgrp www-data [local erdiko code path]/var

  4. Save changes and restart your web server.

  5. Type http://localhost into your browser (or your virtual host name)

  6. If you can see the Hello world page, you have successfully installed Erdiko!

Keep in mind

All of your server side application code should go in the /app folder.

All js, css, or media files or asset should go in the /public folder.

Theme files go in the /app/themes folder while view files and application code goes in the /app/views folder.

Do not modify files in /vendor/erdiko/* if you want to maintain an easy upgrade path with Erdiko.

Create add your first page

  1. We will first need to add a tab to the menu. To do so, open the main config file located at Erdiko/app/config/application/default.json

  2. Find the menu section and insert the following code.

  1. After inserting the code above, the menu section should look like this.
  1. Save the changes of the file, and open the site in your browser. You should be able to see that there is a new tab on the menu.

When you click on the tab, it will show error.

This is normal because you have not set any contents to the page.

Set content of a page

  1. To add contents to a page, open the page config file located at Erdiko/app/controllers/Example.php.

  2. Add the following function inside the Index class

  1. Save the changes and open the site in your browser. You should be able to see your first page.

Well done! You successfully create your first page using Erdiko.

Note

If you want to create a full page, you can add the following line in the getMyfirstpage function.
$this->setTemplate('fullpage');

Use a PHP template

  1. Open the corresponding controller file under the folder Erdiko/app/controllers/.

  2. Inside the controller, find the function of the page you want to use PHP.

  3. Insert the following code:

    $this->addView('[Path of the .php file]');

The root of the path is Erdiko/app/views

For example, if you want to use the php file located at Erdiko/app/views/example/test.php, the path will be /example/test

Add JavaScript to a page

  1. Open the corresponding controller file under the folder Erdiko/www/app/controllers/.

  2. Inside the controller, find the function of the page you want to use Javascript.

  3. Insert the following code:

    $this->addJs('[Path of the .js file]');

The webserver root is /public

For example, if you want to include an example.js file the path will be /public/themes/bootstrap/js/example.js.