Começando

Pré-requisitos

Para começar a usar o Easy Docs, alguns itens são necessários:

Pré-requisitos: Sistema operacional Linux compatível:

1. Debian, Ubuntu, RedHat, CentOS, Fedora, Suse, Amazon Linux, Oracle Linux
2. Acesso de superusuário ou permissões de sudo.
3. Conhecimento básico de linha de comando linux
4. Git instalado no seu sistema.
5. (Para criar os templates) Node.js e npm instalados no seu sistema.

Passos para começar:

Instalando o Git (usando apt)

Se você estiver usando um sistema baseado em Debian ou Ubuntu, ou derivados, pode instalar o Git usando o comando:

$ sudo apt update
$ sudo apt install git

Instalando o Git (usando yum)

Se você estiver usando um sistema baseado em RedHat, CebtOS, Amazon Linux ou derivados, pode instalar o Git usando o comando:

$ sudo yum update
$ sudo yum install git

Instalando o Node (usando NVM)

Para instalar o Node.js e o npm, você pode usar o NVM (Node Version Manager). Para instalar o NVM, execute o seguinte comando:

$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash

Após a instalação do NVM, você pode instalar o Node.js e o npm executando o seguinte comando:

$ nvm install VERSÃO_DO_NODE

Substitua VERSÃO_DO_NODE pela versão do Node.js que você deseja instalar. Por exemplo, para instalar a versão 18, você pode executar o seguinte comando:

$ nvm install 18

Clone o projeto:

Primeiro, você precisa clonar o repositório do easy monitor para o seu sistema. Você pode fazer isso executando o seguinte comando no seu terminal:

$ git clone https://github.com/db1group/easy-docs

Após clonar o repositório, navegue para o diretório:

$ cd easy-docs

Começando em modo de desenvolvimento

Para rodar o prjeto em modo desenvolvimento, você pode executar o seguinte comando:

    npm run dev

ou

    yarn dev

Em modo desenvolvimento, vamos precisar instalar algumas dependencias em nosso ambiente.

Instalando dependências

Para instalar as dependências do projeto, você pode executar o seguinte comando:

   export WKTHMLTOPDF_ARCH=$(case "$(arch)" in "aarch64" | "arm64") echo "arm64" ;; *) echo "amd64" ;; esac)

    export WKTHMLTOPDF_URL=$(echo "https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6-1/wkhtmltox_0.12.6-1.buster_$WKTHMLTOPDF_ARCH.deb")

    sudo apt update

    sudo apt install -y libfontenc1 xfonts-75dpi xfonts-base xfonts-encodings xfonts-utils

    curl -L $WKTHMLTOPDF_URL > /tmp/wkhtmltopdf.deb

    dpkg -i /tmp/wkhtmltopdf.deb

    sudo apt --fix-broken install -y

    sudo apt install wkhtmltopdf

Importante

Essas dependências são necessárias somente em modo desenvolvimento, mas você pode utilizar o docker para rodar o projeto sem precisar instalar essas dependências.

Em modo de produção, essas dependências não são necessárias, pois o projeto roda em um container docker que já possui essas dependências instaladas.