Este guia vai te ajudar a instalar e usar o MarkAPI no seu computador para converter e validar documentos XML.

Tempo estimado: 30-45 minutos na primeira vez

• Converter documentos DOCX para XML
• Validar documentos XML
• Converter XML para HTML e PDF
• Trabalhar com documentos científicos no padrão SciELO

O Docker é necessário para rodar o MarkAPI.

Windows:

1. Acesse https://www.docker.com/products/docker-desktop/
2. Clique em "Download for Windows"
3. Execute o instalador e siga as instruções padrão
4. Reinicie o computador quando solicitado
5. Abra o Docker Desktop e aguarde até ver "Docker Desktop is running"

Mac:

1. Acesse https://www.docker.com/products/docker-desktop/
2. Clique em "Download for Mac"
3. Abra o arquivo .dmg e arraste Docker para Applications
4. Abra o Docker Desktop e aguarde inicializar

Linux (Ubuntu/Debian):

sudo apt update
sudo apt install docker.io docker-compose
sudo systemctl start docker
sudo systemctl enable docker
sudo usermod -aG docker $USER

Após executar os comandos, reinicie o computador.

Como verificar: Abra o Terminal e digite docker --version. Deve aparecer a versão instalada.

Windows:

1. Acesse https://git-scm.com/download/win
2. Baixe e instale usando as opções padrão

Mac:

1. Abra o Terminal
2. Digite git --version
3. Se pedir para instalar, clique em "Instalar"

Linux:

sudo apt install git

Como verificar: Digite git --version no Terminal. Deve aparecer a versão instalada.

Escolha onde guardar o MarkAPI no seu computador.

Exemplos:

• Windows: C:\Users\SeuNome\Projetos
• Mac/Linux: /home/seunome/projetos

Windows:

1. Abra o Explorador de Arquivos na pasta escolhida
2. Clique na barra de endereço e digite cmd
3. Pressione Enter

Mac:

1. Abra o Finder na pasta escolhida
2. Botão direito → "Services" → "New Terminal at Folder"

Linux:

1. Abra o gerenciador de arquivos na pasta escolhida
2. Botão direito → "Abrir no Terminal"

No Terminal, digite:

git clone https://github.com/scieloorg/markapi.git

Aguarde o download concluir.

cd markapi

O MarkAPI precisa de pastas para guardar arquivos e dados.

cd ..

Windows:

mkdir markup_data
cd markup_data
mkdir media
mkdir database
cd database
mkdir data
mkdir backup
cd ..
cd ..
cd markapi

Mac/Linux:

mkdir -p markup_data/media
mkdir -p markup_data/database/data
mkdir -p markup_data/database/backup
cd markapi

Este passo pode demorar 5 a 15 minutos.

Digite pwd (Mac/Linux) ou cd (Windows) para confirmar que você está na pasta markapi.

make build

Aguarde até o processo terminar. Você verá muitas linhas de texto na tela.

make up

Aguarde alguns segundos até os containers iniciarem.

make ps

Você deve ver 7 containers com status "Up".

Execute apenas uma vez, na primeira instalação.

make django_migrate

Aguarde até aparecer várias mensagens "OK".

make django_createsuperuser

Digite quando solicitado:

• Username: seu nome de usuário (exemplo: admin)
• Email: seu email
• Password: sua senha (não aparece na tela ao digitar)
• Password (again): mesma senha novamente

Importante: Anote esses dados. Você precisará deles para acessar o sistema.

Acesse no seu navegador:

http://localhost:8009

1. Clique em "Entrar" ou "Login"
2. Digite o username e senha que você criou
3. Você está dentro do sistema

Sempre que quiser usar:

1. Abra o Docker Desktop e aguarde carregar
2. Abra o Terminal na pasta do MarkAPI
3. Digite: make up
4. Aguarde alguns segundos
5. Acesse: http://localhost:8009

Quando terminar:

make stop

Solução:

• Abra o Docker Desktop
• Aguarde até aparecer "Docker Desktop is running"
• Tente o comando novamente

Solução (Linux/Mac):

sudo usermod -aG docker $USER

Depois reinicie o computador.

Outro programa está usando a porta 8009.

Solução (Windows):

• Abra o Gerenciador de Tarefas (Ctrl+Shift+Esc)
• Feche programas que possam estar usando a porta
• Tente make up novamente

Solução (Mac/Linux):

sudo lsof -i :8009
sudo kill -9 [número_do_PID]

Soluções:

1. Verifique se está ligado: make ps
2. Aguarde 1-2 minutos após iniciar
3. Tente: http://127.0.0.1:8009
4. Veja os logs: make logs

Solução:

1. Verifique se o Docker Desktop está rodando
2. Verifique sua conexão com internet
3. Tente: make build_no_cache

Solução:

docker logs markapi_local_django
make stop
make build
make up

make ps # Ver status dos containers
make logs # Ver logs em tempo real
make stop # Parar todos os containers
make restart # Reiniciar containers

make dump_data # Fazer backup do banco
make restore_data # Restaurar backup

make django_shell # Abrir shell Python
make django_bash # Abrir terminal no container

• Arquivos enviados: markup_data/media/
• Banco de dados: markup_data/database/data/

Para fazer backup, copie a pasta markup_data para um local seguro.

Quando sair uma nova versão:

make stop
git pull
make build
make django_migrate
make up

AI Assisted

Documentação elaborada com auxílio de IA.