Add simplified installation and update process for end users#33
Draft
Add simplified installation and update process for end users#33
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 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 environmentsupdate.sh- Simple update process with optional database backupinstall-production.sh- Production deployment with security checksAll scripts include:
Comprehensive Documentation
Three new documentation files in Portuguese and English:
INSTALLATION.md(9KB) - Complete installation guide with detailed troubleshooting sectionQUICK_START.md(1.3KB) - Quick reference card for common commandsLEIA-ME.md(4.5KB) - Full Portuguese README for Brazilian usersConfiguration Templates
Added
.exampletemplate files for safe configuration management:These templates allow users to customize their configuration without exposing credentials in version control.
Makefile Integration
Added convenient make targets:
🚀 Usage
For End Users (Non-Developers)
Installation:
Update:
Access:
For Developers
The new scripts integrate seamlessly with existing development workflows. All existing
maketargets continue to work as before.🔒 Security Improvements
📚 Documentation Structure
The main
README.mdnow has a dedicated "Quick Start for End Users" section linking to:LEIA-ME.md)QUICK_START.md)INSTALLATION.md)🔗 Related Issues
Closes #30 - Completar a documentação da aplicação para o usuário final
✅ Testing
📝 Notes
.envs/.local/.djangoand.envs/.local/.postgres) remain in the repository for backward compatibility.examplefiles as templatesINSTALLATION.mdOriginal prompt
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.