Semantic Table Linker - Client

Semantic Table Linker Client (STL-Client) A web-based application (a client part) to annotate tabular data.

STL-Client is based on PHP 7 and Yii 2 Framework.

Version

1.0

DIRECTORY STRUCTURE

  commands/      contains console commands (controllers) for creation of languages by default
  components/    contains language components (widget)
  config/        contains main configurations for this application and database
  controllers/   contains controller actions
  messages/      contains internationalization files for English and Russian languages
  migrations/    contains migration for language table creation
  models/        contains data model for language and other forms
  views/         contains views (main template and different pages)
  web/           contains js-scripts, css-scripts, images and other web resources

REQUIREMENTS

The minimum requirement by this project that your Web server supports PHP 7.0, PostgreSQL 9.0 or MySQL 8.0.

We recommend you to use a combination of PHP 8 with DBMS PostgreSQL 15 or more.

INSTALLATION

Install via Git

If you do not have Git, you can install it depending on your OS.

You can clone this project into your directory (recommended installation):

https://github.com/YRL-AIDA/stl-client.git

Update dependencies

After installation, you need to update project's dependencies. In particular, this includes installing Yii2 framework itself into the vendor folder.

The following commands are entered sequentially into the console (located in the project folder):

• composer self-update — Composer update;
• composer global update — Composer global update;
• composer clear-cache — clearing Composer's internal package cache;
• composer update — update all dependencies to the latest versions.

NOTES: If for some reason the dependencies could not be installed (there is no vendor folder), then you need to manually add the vendor folder to this project.

CONFIGURATION

Database

Edit the file config/db.php with real data, for example:

PostgreSQL:

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'pgsql:host=localhost;port=5432;dbname=stlclient;',
    'username' => 'postgres',
    'password' => 'root',
    'charset' => 'utf8',
    'tablePrefix' => 'stlclient_',
    'schemaMap' => [
        'pgsql'=> [
            'class'=>'yii\db\pgsql\Schema',
            'defaultSchema' => 'public'
        ]
    ],
];

MySQL:

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=stlclient;',
    'username' => 'admin',
    'password' => 'root',
    'charset' => 'utf8',
    'tablePrefix' => 'stlclient_',
];

NOTES:

• STL-Client won't create a new database for you, this has to be done manually before you can access it.
• Check and edit the other files in the config/ directory to customize your application as required.

Database commands:

STL-Client contains commands for filling a new database with the initial data (languages) necessary for the application to run. This set of commands entered sequentially into the console (located in the project folder):

• php yii migrate/up — applying migrations (creating a table in a new database);
• php yii lang/create — creating default locales for RU and EN in a new database.

AUTHORS

• Nikita O. Dorodnykh