File tree Expand file tree Collapse file tree 3 files changed +82
-3
lines changed Expand file tree Collapse file tree 3 files changed +82
-3
lines changed Original file line number Diff line number Diff line change @@ -61,6 +61,9 @@ Execute o script de instalação:
6161
6262# Para Windows (usando Git Bash):
6363bash install.sh
64+
65+ # Ou simplesmente use o Makefile (funciona em todos os sistemas):
66+ make install
6467```
6568
6669O script irá:
@@ -106,6 +109,9 @@ Para atualizar o MarkAPI para a versão mais recente:
106109
107110# Para Windows (usando Git Bash):
108111bash update.sh
112+
113+ # Ou simplesmente use o Makefile (funciona em todos os sistemas):
114+ make update
109115```
110116
111117O script de atualização irá:
Original file line number Diff line number Diff line change 1+ # MarkAPI - Guia Rápido
2+
3+ ## Instalação (Primeira Vez)
4+
5+ ``` bash
6+ # 1. Clone ou baixe o repositório
7+ git clone https://github.com/scieloorg/markapi.git
8+ cd markapi
9+
10+ # 2. Configure os arquivos de ambiente
11+ cp .envs/.local/.django.example .envs/.local/.django
12+ cp .envs/.local/.postgres.example .envs/.local/.postgres
13+
14+ # 3. Execute a instalação
15+ ./install.sh
16+ # ou
17+ make install
18+
19+ # 4. Crie um superusuário
20+ docker compose -f local.yml run --rm django python manage.py createsuperuser
21+ ```
22+
23+ ## Atualização
24+
25+ ``` bash
26+ cd markapi
27+ ./update.sh
28+ # ou
29+ make update
30+ ```
31+
32+ ## Comandos Essenciais
33+
34+ ### Iniciar
35+ ``` bash
36+ docker compose -f local.yml up -d
37+ ```
38+
39+ ### Parar
40+ ``` bash
41+ docker compose -f local.yml stop
42+ ```
43+
44+ ### Ver Logs
45+ ``` bash
46+ docker compose -f local.yml logs -f
47+ ```
48+
49+ ### Status
50+ ``` bash
51+ docker compose -f local.yml ps
52+ ```
53+
54+ ## Acessos
55+
56+ - ** Aplicação** : http://localhost:8009
57+ - ** Admin** : http://localhost:8009/admin
58+ - ** Email** : http://localhost:8029
59+ - ** Celery** : http://localhost:5559
60+
61+ ## Backup
62+
63+ ``` bash
64+ mkdir -p backup
65+ docker exec markapi_local_postgres pg_dumpall -c -U debug > backup/backup_$( date +%Y%m%d_%H%M%S) .sql
66+ ```
67+
68+ ## Problemas?
69+
70+ Consulte o [ Guia de Instalação Completo] ( INSTALLATION.md ) para mais detalhes e solução de problemas.
Original file line number Diff line number Diff line change @@ -14,11 +14,14 @@ License: GPLv3
1414
1515## Quick Start for End Users
1616
17- ** For end users** (non-developers) who want to install and use MarkAPI, please see the simplified ** [ Installation Guide] ( INSTALLATION.md ) ** .
17+ ** For end users** (non-developers) who want to install and use MarkAPI:
18+
19+ - ** [ Quick Start Guide] ( QUICK_START.md ) ** - Fast installation with essential commands
20+ - ** [ Complete Installation Guide] ( INSTALLATION.md ) ** - Detailed instructions with troubleshooting
1821
1922The Installation Guide includes:
20- - Easy installation with automated script
21- - Simple update process
23+ - Easy installation with automated script ( ` install.sh ` or ` make install ` )
24+ - Simple update process ( ` update.sh ` or ` make update ` )
2225- Common commands and troubleshooting
2326- User-friendly instructions in Portuguese
2427
You can’t perform that action at this time.
0 commit comments