Getting Started

¶Installation

Note

This is the quick installation note for local - dev - review

¶Checkout the project

mkdir AutoMarkdoc
cd AutoMarkdoc
git clone https://github.com/partITech/AutoMarkDoc .

¶Local server instance

Caution

Install docker and docker compose if not already done.

Firstly build images, then launch

docker compose build
docker compose up -d

¶Update dependencies

As this project is made with PHP 8.4 and the framework Symfony, some few commands are required to checkout all needed files.

docker compose exec php composer install

Important

a minimal .env is required See the General configuration for more information

DOCUMENTATION_PROJECTS='{
    "automarkdoc": {
    "path": "documentations/AutoMarkDoc",
    "segment": "automarkdoc",
    "host": "localhost",
    "name": "AutoMarkDoc"
    }
}'

Update this in the .env to use your files.

See the General configuration section to learn more about basic configurations