Skip to content

Commit d9ea089

Browse files
Add Portuguese README and finalize installation documentation
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
1 parent d7a8be2 commit d9ea089

File tree

2 files changed

+199
-1
lines changed

2 files changed

+199
-1
lines changed

LEIA-ME.md

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
# MarkAPI - Guia de Instalação em Português
2+
3+
Este é um guia simplificado em português para instalação e uso do MarkAPI.
4+
5+
## 📋 Índice
6+
7+
1. [Instalação Rápida](#instalação-rápida)
8+
2. [Instalação Detalhada](INSTALLATION.md)
9+
3. [Guia Rápido de Comandos](QUICK_START.md)
10+
4. [Atualização](#atualização)
11+
5. [Comandos Úteis](#comandos-úteis)
12+
13+
## 🚀 Instalação Rápida
14+
15+
### Pré-requisitos
16+
17+
- Docker e Docker Compose instalados
18+
- Git (opcional, mas recomendado)
19+
20+
### Passos
21+
22+
1. **Clone o repositório:**
23+
```bash
24+
git clone https://github.com/scieloorg/markapi.git
25+
cd markapi
26+
```
27+
28+
2. **Configure as variáveis de ambiente:**
29+
```bash
30+
cp .envs/.local/.django.example .envs/.local/.django
31+
cp .envs/.local/.postgres.example .envs/.local/.postgres
32+
```
33+
34+
**IMPORTANTE**: Edite os arquivos `.envs/.local/.django` e `.envs/.local/.postgres` para alterar as senhas!
35+
36+
3. **Execute a instalação:**
37+
```bash
38+
./install.sh
39+
# ou
40+
make install
41+
```
42+
43+
4. **Crie um superusuário:**
44+
```bash
45+
docker compose -f local.yml run --rm django python manage.py createsuperuser
46+
```
47+
48+
5. **Acesse a aplicação:**
49+
- Aplicação: http://localhost:8009
50+
- Admin: http://localhost:8009/admin
51+
52+
## 🔄 Atualização
53+
54+
Para atualizar para a versão mais recente:
55+
56+
```bash
57+
./update.sh
58+
# ou
59+
make update
60+
```
61+
62+
O script irá:
63+
- Criar backup do banco de dados (opcional)
64+
- Atualizar o código
65+
- Reconstruir as imagens
66+
- Executar migrações
67+
68+
## 📚 Comandos Úteis
69+
70+
### Gerenciamento Básico
71+
72+
```bash
73+
# Iniciar
74+
docker compose -f local.yml up -d
75+
76+
# Parar
77+
docker compose -f local.yml stop
78+
79+
# Reiniciar
80+
docker compose -f local.yml restart
81+
82+
# Ver logs
83+
docker compose -f local.yml logs -f
84+
85+
# Status
86+
docker compose -f local.yml ps
87+
```
88+
89+
### Backup e Restauração
90+
91+
```bash
92+
# Fazer backup
93+
mkdir -p backup
94+
docker exec markapi_local_postgres pg_dumpall -c -U debug > backup/backup_$(date +%Y%m%d_%H%M%S).sql
95+
96+
# Restaurar backup
97+
cat backup/seu_arquivo.sql | docker exec -i markapi_local_postgres psql -U debug
98+
```
99+
100+
### Comandos Django
101+
102+
```bash
103+
# Shell Python
104+
docker compose -f local.yml run --rm django python manage.py shell
105+
106+
# Terminal bash
107+
docker compose -f local.yml run --rm django bash
108+
109+
# Executar testes
110+
docker compose -f local.yml run --rm django python manage.py test
111+
112+
# Criar migrações
113+
docker compose -f local.yml run --rm django python manage.py makemigrations
114+
115+
# Aplicar migrações
116+
docker compose -f local.yml run --rm django python manage.py migrate
117+
```
118+
119+
## 🛠️ Solução de Problemas
120+
121+
### Porta já em uso
122+
123+
Se receber erro de porta em uso, você pode:
124+
125+
1. Parar o serviço que está usando a porta
126+
2. Alterar a porta no arquivo `local.yml`
127+
128+
### Erro de permissão
129+
130+
```bash
131+
# Linux/Mac
132+
sudo chown -R $USER:$USER ../scms_data/markapi
133+
```
134+
135+
### Container não inicia
136+
137+
```bash
138+
# Ver logs detalhados
139+
docker compose -f local.yml logs
140+
141+
# Reconstruir sem cache
142+
docker compose -f local.yml build --no-cache
143+
docker compose -f local.yml up -d
144+
```
145+
146+
### Resetar tudo
147+
148+
```bash
149+
# CUIDADO: Isso apagará todos os dados!
150+
docker compose -f local.yml down -v
151+
rm -rf ../scms_data/markapi/data_dev/*
152+
./install.sh
153+
```
154+
155+
## 📖 Documentação Completa
156+
157+
- **[Guia Rápido](QUICK_START.md)** - Comandos essenciais
158+
- **[Instalação Completa](INSTALLATION.md)** - Guia detalhado com troubleshooting
159+
- **[README Principal](README.md)** - Documentação técnica completa
160+
161+
## 🌐 Recursos
162+
163+
- Wiki: https://github.com/scieloorg/markapi/wiki
164+
- Issues: https://github.com/scieloorg/markapi/issues
165+
- Guia de conversão XML para PDF: https://github.com/scieloorg/markapi/wiki/Converter-XML-para-PDF
166+
167+
## 🏭 Produção
168+
169+
Para instalação em ambiente de produção, veja:
170+
171+
- [Seção de Produção no INSTALLATION.md](INSTALLATION.md#instalação-em-produção)
172+
- Script `install-production.sh` (requer production.yml)
173+
- Configurações Kubernetes na pasta `kubernetes/`
174+
175+
## 💡 Dicas
176+
177+
1. **Primeira instalação**: Pode levar 10-20 minutos
178+
2. **Senhas**: Sempre altere as senhas padrão!
179+
3. **Backups**: Configure backups regulares em produção
180+
4. **Logs**: Use `docker compose logs -f` para acompanhar problemas
181+
5. **Recursos**: Monitore uso de CPU/memória com `docker stats`
182+
183+
## 🤝 Contribuindo
184+
185+
Se encontrou um problema ou tem uma sugestão:
186+
187+
1. Verifique se já existe uma issue
188+
2. Crie uma nova issue com detalhes
189+
3. Contribua com melhorias via Pull Request
190+
191+
## 📝 Licença
192+
193+
GPLv3 - Veja arquivo LICENSE para detalhes.
194+
195+
---
196+
197+
**Nota**: Este documento é complementar à documentação em inglês no README.md principal.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,15 @@ License: GPLv3
1616

1717
**For end users** (non-developers) who want to install and use MarkAPI:
1818

19+
- **[🇧🇷 LEIA-ME em Português](LEIA-ME.md)** - Guia completo em português
1920
- **[Quick Start Guide](QUICK_START.md)** - Fast installation with essential commands
2021
- **[Complete Installation Guide](INSTALLATION.md)** - Detailed instructions with troubleshooting
2122

2223
The Installation Guide includes:
2324
- Easy installation with automated script (`install.sh` or `make install`)
2425
- Simple update process (`update.sh` or `make update`)
2526
- Common commands and troubleshooting
26-
- User-friendly instructions in Portuguese
27+
- User-friendly instructions
2728

2829
---
2930

0 commit comments

Comments
 (0)