Skip to content

Add simplified installation and update process for end users#33

Draft
Copilot wants to merge 5 commits intomainfrom
copilot/simplify-web-installation-updates
Draft

Add simplified installation and update process for end users#33
Copilot wants to merge 5 commits intomainfrom
copilot/simplify-web-installation-updates

Conversation

Copy link
Copy Markdown

Copilot AI commented Oct 14, 2025

🎯 Overview

This PR implements a simplified installation and update process for the MarkAPI web application, addressing issue #30 by making it easier for end users (non-developers) to install and maintain the application.

📦 What's New

Automated Installation Scripts

Three new bash scripts provide one-command installation and updates:

  • install.sh - Automated installation for development/local environments
  • update.sh - Simple update process with optional database backup
  • install-production.sh - Production deployment with security checks

All scripts include:

  • Automatic dependency verification (Docker/Docker Compose)
  • Directory creation and configuration
  • Database migrations and Wagtail setup
  • Colored, user-friendly output
  • Clear error messages and warnings

Comprehensive Documentation

Three new documentation files in Portuguese and English:

  • INSTALLATION.md (9KB) - Complete installation guide with detailed troubleshooting section
  • QUICK_START.md (1.3KB) - Quick reference card for common commands
  • LEIA-ME.md (4.5KB) - Full Portuguese README for Brazilian users

Configuration Templates

Added .example template files for safe configuration management:

.envs/.local/.django.example
.envs/.local/.postgres.example
.envs/.production/.django.example
.envs/.production/.postgres.example

These templates allow users to customize their configuration without exposing credentials in version control.

Makefile Integration

Added convenient make targets:

make install  # Run installation script
make update   # Run update script

🚀 Usage

For End Users (Non-Developers)

Installation:

git clone https://github.com/scieloorg/markapi.git
cd markapi
cp .envs/.local/.django.example .envs/.local/.django
cp .envs/.local/.postgres.example .envs/.local/.postgres
# Edit the files to change default passwords
./install.sh

Update:

./update.sh

Access:

For Developers

The new scripts integrate seamlessly with existing development workflows. All existing make targets continue to work as before.

🔒 Security Improvements

  • Configuration templates prevent accidental credential commits
  • Production script validates critical security settings
  • Clear warnings about changing default passwords
  • No hardcoded sensitive information

📚 Documentation Structure

The main README.md now has a dedicated "Quick Start for End Users" section linking to:

  • 🇧🇷 Portuguese guide (LEIA-ME.md)
  • Fast reference (QUICK_START.md)
  • Complete guide (INSTALLATION.md)

🔗 Related Issues

Closes #30 - Completar a documentação da aplicação para o usuário final

✅ Testing

  • All bash scripts pass syntax validation
  • Makefile targets verified and documented
  • CodeQL security checks passed
  • Example configuration files tested

📝 Notes

  • The existing environment files (.envs/.local/.django and .envs/.local/.postgres) remain in the repository for backward compatibility
  • Users are encouraged to use the new .example files as templates
  • Production deployment requires additional configuration (domain, SSL, etc.) as documented in INSTALLATION.md
Original prompt

This section details on the original issue you should resolve

<issue_title>Criar uma forma mais facilitada para o usuário final instalar / atualizar a aplicação web</issue_title>
<issue_description>relacionado com #30 </issue_description>

<agent_instructions>Criar uma forma mais facilitada para o usuário final instalar / atualizar a aplicação web criada com wagtail customizada </agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #32


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 4 commits October 14, 2025 17:59
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Add user-friendly installation and update process for web application Add simplified installation and update process for end users Oct 14, 2025
Copilot AI requested a review from robertatakenaka October 14, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants