diff --git a/INSTALL b/INSTALL new file mode 100644 index 00000000..fd5b701f --- /dev/null +++ b/INSTALL @@ -0,0 +1,3 @@ +Installation instructions can be found in the following directory: + +data/docs/install.txt diff --git a/LICENSE b/LICENSE index 4aa906f5..d6763678 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2015 Tobias Krebs +Copyright (c) 2018 Tobias Krebs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README b/README index 016c91ea..de9d368d 100644 --- a/README +++ b/README @@ -1,3 +1,9 @@ Documentation and installation instructions can be found in the following directory: -/data/docs/ +data/docs/ + + + +Especially: + +data/docs/install.txt diff --git a/README.md b/README.md index bb89f31c..15bf9986 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ yourself. Documentation and installation instructions can be found in the following directory: ``` -/data/docs/ +data/docs/ ``` ## Architecture @@ -41,7 +41,9 @@ where you can find stable and (latest) development releases. ## Version -The current version (July, 2016) is 1.6. +The current version (February, 2018) is 1.6.2. + +Version 1.6.2 changed the configuration behaviour and requires some manual changes (see data/docs/update.txt). Otherwise, the update will not work. Version 1.6 introduced some requested features and fixed quite some bugs. It also introduced better support for custom translations and modules. diff --git a/VERSION b/VERSION index 9da92c3b..4bffc9ea 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.6 +1.6.2 diff --git a/config/application.php b/config/application.php index 3231c91b..c0c9bc12 100644 --- a/config/application.php +++ b/config/application.php @@ -1,18 +1,17 @@ array( 'driver' => 'pdo_mysql', diff --git a/config/autoload/local.php.dist b/config/autoload/local.php.dist index c3ff5109..bcd06ce6 100644 --- a/config/autoload/local.php.dist +++ b/config/autoload/local.php.dist @@ -6,8 +6,6 @@ * and provide the email address the system should use. */ -ini_set('date.timezone', 'America/New_York'); - return array( 'db' => array( 'database' => '?', @@ -28,7 +26,7 @@ return array( 'port' => 'auto', // for 'smtp' type only, otherwise remove or leave as is ), 'i18n' => array( - 'locale' => 'en-US', - 'currency' => 'USD', + 'locale' => 'de-DE', + 'currency' => 'EUR', ), ); diff --git a/config/init.php.dist b/config/init.php.dist index 08e00fb6..b5c09f10 100644 --- a/config/init.php.dist +++ b/config/init.php.dist @@ -1,3 +1,39 @@ 'ep3-bs-setup', 'cache_dir' => getcwd() . '/data/cache/', ), -); \ No newline at end of file +); diff --git a/data/docs/install-extra-modules.txt b/data/docs/install-extra-modules.txt index c3868e61..8163a493 100644 --- a/data/docs/install-extra-modules.txt +++ b/data/docs/install-extra-modules.txt @@ -1 +1 @@ -Simply copy custom or (third party) extra modules in the /modulex directory and they will be loaded automatically. +Simply copy custom or (third party) extra modules in the modulex directory and they will be loaded automatically. diff --git a/data/docs/install.txt b/data/docs/install.txt index f57fd063..fb372c68 100644 --- a/data/docs/install.txt +++ b/data/docs/install.txt @@ -6,30 +6,38 @@ continue with installation. 0. Install dependencies via composer + + --- Installation --- 1. Setup local configuration - - rename /config/autoload/local.php.dist to local.php + - rename config/init.php.dist to init.php + - edit init.php + + - rename config/autoload/local.php.dist to local.php - edit local.php 2. Enable (recursively) UNIX write permission for - - /data/cache/ - - /data/log/ - - /data/session/ - - /public/docs-client/upload/ - - /public/imgs-client/upload/ + - data/cache/ + - data/log/ + - data/session/ + - public/docs-client/upload/ + - public/imgs-client/upload/ 3. Setup the database via setup.php 4. Delete setup tool - - /public/setup.php + - public/setup.php + +5. Delete any files in the following directory + - data/cache/ -5. Customize public files (optional) +6. Customize public files (optional) - css-client/default.css (custom color scheme) - imgs-client/icons/fav.ico - imgs-client/layout/logo.png (75x75) -6. Have fun! :) +7. Have fun! :) diff --git a/data/docs/details/architecture.txt b/data/docs/internals/architecture.txt similarity index 95% rename from data/docs/details/architecture.txt rename to data/docs/internals/architecture.txt index 053f6fbc..8811f424 100644 --- a/data/docs/details/architecture.txt +++ b/data/docs/internals/architecture.txt @@ -1,5 +1,3 @@ -Notes on the architecture: - - index.php changes working directory, loads and registers the standard autoloader and invokes the application init() method with the application's global config (which essentially determines which modules to load, where to find them and which other global config files should be loaded and merged with each module config) @@ -37,4 +35,4 @@ Notes on the architecture: * determine controller from RouteMatch * if found and dispatchable, call it, otherwise trigger dispatch.error 3. render - 4. finish \ No newline at end of file + 4. finish diff --git a/data/docs/details/backend/booking.ep b/data/docs/internals/backend/booking.ep similarity index 100% rename from data/docs/details/backend/booking.ep rename to data/docs/internals/backend/booking.ep diff --git a/data/docs/details/release.txt b/data/docs/internals/on-update.txt similarity index 73% rename from data/docs/details/release.txt rename to data/docs/internals/on-update.txt index 4a3670b2..4e89c066 100644 --- a/data/docs/details/release.txt +++ b/data/docs/internals/on-update.txt @@ -1,5 +1,3 @@ -On new release: - - Update features - Update documentation @@ -8,4 +6,4 @@ On new release: - VERSION - Update package -- Update demo \ No newline at end of file +- Update demo diff --git a/data/docs/todo-events.txt b/data/docs/todo-events.txt deleted file mode 100644 index a9b5a9ef..00000000 --- a/data/docs/todo-events.txt +++ /dev/null @@ -1,4 +0,0 @@ -Long Term: - -- Events can have participants (tables/managers) -- Participation process like booking process diff --git a/data/docs/todo.txt b/data/docs/todo.txt index 4fbe0550..fea54f08 100644 --- a/data/docs/todo.txt +++ b/data/docs/todo.txt @@ -1,8 +1,7 @@ -Short Term: - - Allow bookings without registration (i.e. inline registration) -Long Term: +- Events should be able to have participants (requires respective tables and managers) +- Participation process like booking process - Introduce testing via PHPUnit/Selenium - Introduce maintenance cronjob diff --git a/data/docs/update.txt b/data/docs/update.txt index aab9ce3e..81095d05 100644 --- a/data/docs/update.txt +++ b/data/docs/update.txt @@ -2,21 +2,41 @@ First backup your database and project directory! +--- Update to 1.6.2 --- + +There have been some internal changes to the configuration directory. Replace the following files: + +- config/init.php.dist +- config/init.php + (and edit it according to your needs; if it does not yet exist, create it by copying init.php.dist) + +- data/docs/* + +- public/index.php + +- vendor/* + (alternatively, you may update dependencies via composer after replacing the composer.json) + +- All single files in the project root directory + + + --- Update to 1.6 --- Replace the following directories and files with the new ones: -- /config/application.php -- /config/modules.php -- /config/setup.php +- config/application.php +- config/modules.php +- config/setup.php -- /data/res/ (if you have custom translations you *can* now place them in /data/res/i18n-custom/ ) +- data/res/ + (if you have custom translations you *can* now place them in data/res/i18n-custom/) -- /module/ -- /modulex/ +- module/ +- modulex/ -- /public/js/ -- /public/index.php +- public/js/ +- public/index.php @@ -24,19 +44,20 @@ Replace the following directories and files with the new ones: Replace the following directories and files with the new ones: -- /data/res/ +- data/res/ -- /module/ +- module/ -- /public/css/ -- /public/docs/ -- /public/imgs/ -- /public/js/ -- /public/misc/ -- /public/vendor/ +- public/css/ +- public/docs/ +- public/imgs/ +- public/js/ +- public/misc/ +- public/vendor/ - index.php -- /vendor/ (alternatively, you may update dependencies via composer after replacing the composer.json) +- vendor/ + (alternatively, you may update dependencies via composer after replacing the composer.json) - All single files in the project root directory @@ -46,7 +67,7 @@ Replace the following directories and files with the new ones: After every update you should delete all files within the -- /data/cache/ +- data/cache/ directory. diff --git a/public/index.php b/public/index.php index 1f833515..89e7bcb8 100644 --- a/public/index.php +++ b/public/index.php @@ -4,7 +4,7 @@ * * ep-3 Bookingsystem * - * (c) 2015 Tobias Krebs + * (c) 2018 Tobias Krebs * * Website: http://bs.hbsys.de/ * License: MIT @@ -59,13 +59,12 @@ require $autoloader; /** - * Load a custom init script if available. + * Initialize our PHP environment. */ $init = 'config/init.php'; -if (is_readable($init)) { - - require $init; +if (! is_readable($init)) { + exit('Please rename config/init.php.dist to config/init.php and edit its options according to your needs'); } /** diff --git a/public/setup.php b/public/setup.php index 2e83b32b..608f889f 100644 --- a/public/setup.php +++ b/public/setup.php @@ -52,13 +52,12 @@ require $autoloader; /** - * Load a custom init script if available. + * Initialize our PHP environment. */ $init = 'config/init.php'; -if (is_readable($init)) { - - require $init; +if (! is_readable($init)) { + exit('Please rename config/init.php.dist to config/init.php and edit its options accordingly'); } /**