README.md

PandaMD

PandaMD is an application that converts markdown files in report in pdf format.

Installation

Pandoc

wget https://github.com/jgm/pandoc/releases/download/2.4/pandoc-2.4-1-amd64.deb
sudo dpkg -i pandoc-2.4-1-amd64.deb
rm pandoc-2.4-1-amd64.deb

Texlive

sudo apt install texlive-full

Template for pandoc

cd /usr/share/pandoc/data/templates
sudo wget https://raw.githubusercontent.com/steven-jeanneret/dotFiles/master/pandoc/eisvogel.latex

PandaMD

We need to give write permission to the user who will execute the queue worker.

git clone https://github.com/HE-Arc/PandaMD.git
cd PandaMD
sudo chmod a+w storage/app -R
composer install
npm install
php artisan migrate
php artisan db:seed #Only if we want default data

Queue manager

Converting markdown to pdf takes time so we make this in a queue in background.

Run on server

We will configure sv, he makes sure that the queue will always turns.

Create /etc/service/laravel-queue-worker/run with the following content :

#!/bin/sh
set -xe
cd /var/www/PandaMD
exec 2>&1
exec chpst -uwww-data php artisan queue:work

sudo chmod a+x run
sudo sv start laravel-queue-worker

Run on local

php artisan queue:work

Imgur API

When drag and dropping an image onto the editor, the image is uploaded on imgur and referenced into the editor. In order to use the API, a client ID is required. To get an Imgur client ID, it is necessary to register to Imgur. The detailed steps can be found in Imgur API reference.

When in possession of a client ID, please add the following line to your .env file:

IMGUR_CLIENT_ID=[your_client_id]

Test

Requirements

Server

Create .env.testing with the following content :

DB_SCHEMA=test

Create Schema test in database

Local

Copy .env in .env.testing and change the schema of the DB.

Before running test

php artisan config:clear
php artisan migrate --seed --env=testing

Run test

Linux:

./vendor/bin/phpunit

Windows:

"./vendor/bin/phpunit"