thelia/hook-admin-home-module

Installs: 31 857

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 5

Forks: 1

Type:thelia-module

2.5.4 2023-12-21 13:59 UTC

README

Warning

This is the development repository of Thelia. If you want to create a project, please take a look at thelia/thelia-project

Thelia

Build Status License Scrutinizer Quality Score

Thelia is an open source tool for creating e-business websites and managing online content. This software is published under LGPL.

This is the new major version of Thelia.

A repository containing all thelia modules is available at this address : https://github.com/thelia-modules

Compatibility

Thelia 2.1 Thelia 2.2 Thelia 2.3 Thelia 2.4
PHP 5.4 5.5 5.6 5.4 5.5 5.6 5.5 5.6 7.0 7.1 5.6 7.0 7.1 7.2
MySQL 5.5 5.6 5.5 5.6 5.5 5.6 5.5 5.6 5.7
Symfony 2.3 2.3 2.8 2.8

Requirements

  • PHP
    • Required extensions :
      • PDO_Mysql
      • openssl
      • intl
      • gd
      • curl
      • dom
    • safe_mode off
    • memory_limit at least 128M, preferably 256.
    • post_max_size 20M
    • upload_max_filesize 2M
    • date.timezone must be defined
  • Web Server Apache 2 or Nginx
  • MySQL 5

MySQL 5.6

As of MySQL 5.6, default configuration sets the sql_mode value to

STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION

This 'STRICT_TRANS_TABLES' configuration results in SQL errors when no default value is defined on NOT NULL columns and the value is empty or invalid.

You can edit this default config in /etc/my.cnf and change the sql_mode to remove the STRICT_TRANS_TABLES part

[mysqld]
sql_mode=NO_ENGINE_SUBSTITUTION

Assuming your sql_mode is the default one, you can change the value directly on the run by running the following SQL Command

SET @@GLOBAL.sql_mode='NO_ENGINE_SUBSTITUTION', @@SESSION.sql_mode='NO_ENGINE_SUBSTITUTION'

For more information on sql_mode you can consult the MySQL doc

Archive builders

Thelia's archive builder's needs external libraries. For zip archives, you need PECL zip. See PHP Doc

For tar archives, you need PECL phar. Moreover, you need to deactivate php.ini option "phar.readonly":

phar.readonly = Off

For tar.bz2 archives, you need tar's dependencies and the extension "bzip2". See PHP Doc

For tar.gz archives, you need tar's dependencies and the extension "zlib". See PHP Doc

Download Thelia 2 and install its dependencies

You can get the sources from git and then let composer install dependencies, or use composer to install the whole thelia project into a specific directory

Using git for download and composer for dependencies

$ git clone --recursive https://github.com/thelia/thelia path
$ cd path
$ git checkout 2.3.3 (2.2.6 or 2.1.11)
$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install

Using composer for both download and dependencies

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar create-project thelia/thelia path/ 2.3.3 (2.2.6 or 2.1.11)

If something goes wrong during the install process, you can restart Thelia install wizard with the following command : php composer.phar run-script post-create-project-cmd

Install it

You can install Thelia by two different way

Using install wizard

Installing thelia with the web install wizard allow to create an administrator, add some informations about your shop, etc

First of all, you have to configure a vhost as describe in configuration section.

The install wizard in accessible with your favorite browser :

http://yourdomain.tld/[/subdomain_if_needed]/install

For example, I have thelia downloaded at http://thelia.net and my vhost is correctly configured, I have to reach this address :

http://thelia.net/install

Using cli tools

$ php Thelia thelia:install

or if you use a Thelia project :

$ php composer.phar run-script post-create-project-cmd

You just have to follow all instructions.

Docker and docker compose

This repo contains all the configuration needed to run Thelia with docker and docker-compose.

It requires obviously docker and docker-compose

To install Thelia within Docker, run :

docker-compose up -d
docker-compose exec web composer install
docker-compose exec web php Thelia thelia:install

This will prompt you for database information. Enter the following :

  • host : mariaDB
  • port : 3306 (default)
  • name : thelia
  • login : root
  • password : toor

tip : create an alias for docker-compose, it's boring to write it all the time

All the scripts can be launched through docker (or the corresponding docker-compose exec web ... command. For example :

docker exec -it thelia_web_1 composer install
docker exec -it thelia_web_1 php Thelia cache:clear
docker exec -it thelia_web_1 php setup/faker.php
docker exec -it thelia_web_1 unit-tests.sh

Once started, you can open your local Thelia website at 127.0.0.1:8080 and your phpMyAdmin installation at 127.0.0.1:8081.

What is missing :

  • confguration for export compression (zip, gzip, etc)

Obviously you can modify all the configuration for your own case, for example the php version or add environment variable for the database configuration. Each time you modify the configuration, you have to rebuild it :

docker-compose build --no-cache

Documentation

Thelia documentation is available at http://doc.thelia.net

Roadmap

The Roadmap is available at http://thelia.net/community/roadmap

Contribute

see the documentation : http://doc.thelia.net/en/documentation/contribute.html

If you submit modifications that adds new data or change the structure of the database, take a look to http://doc.thelia.net/en/documentation/contribute.html#sql-scripts-modification

Usage

Consult the page : http://localhost/thelia/web/index_dev.php

You can create a virtual host and choose web folder for root directory.

To run tests (phpunit required) :

$ phpunit

We still have lot of work to achieve but enjoy this part.