FNBr Webtool [Docker Container]

FrameNet Brasil (FNBr) Webtool is an annotation and database management application developed by FrameNet Brasil Project, which can be accessed using any web browser, without the need to install any additional software. Webtool handles multilingual framenets and constructicons.

Webtool app is implemented using Framework Maestro, a PHP7 framework developed at Federal University of Juiz de Fora - UFJF (Brazil).

This repository contains a customized Maestro copy. Webtool app is localized at folder apps/webtool.

Prerequisities

In order to run this container you'll need docker installed.

• Windows
• OS X
• Linux

Usage

Create a local installation for Webtool:

• Clone this repository at an accesible folder

$ git clone https://github.com/FrameNetBrasil/webtool.git
$ cd webtool

• Start the container

$ docker-compose up

• Create the MySQL/MariaDb database from the dump file

webtool/apps/webtool/dump/webtool_db.tar.gz

• Update the database credentials at .env file

webtool/.env

• Configuration file for Webtool is located at

webtool/apps/webtool/conf/conf.php

• Access the app at http://localhost:8001 (with user = admin password = admin)

Built With

• PHP 7.4
• MariaDb 10.4
• PhpMyAdmin 5.0.1
• Framework Maestro 3.0
• Vue 2.7

Tutorials

See this YouTube channel for tutorials on the main functions of the WebTool.

Find Us

• GitHub
• FrameNet Brasil

Contributing

• Create a new branch with a meaningful name git checkout -b branch_name.
  
• Develop your feature on Xcode IDE and run it .
  
• Add the files you changed git add file_name.
  
• Commit your changes git commit -m "Message briefly explaining the feature".
  
• Keep one commit per feature. If you forgot to add changes, you can edit the previous commit git commit --amend.
  
• Push to your repo git push --set-upstream origin branch-name.
  
• Go into the Github repo and create a pull request explaining your changes.
  

License

GNU GPLv3 - See the COPYING file for license rights and limitations.