txeo/cv-site
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finalize documentation as personal portfolio project

Browse Source 
- Add clear disclaimers: personal site, not a template
- Update CONTRIBUTING.md: not seeking contributions
- Remove all Docker files and references (11 files)
- Rewrite DEPLOYMENT.md without Docker (VPS/cloud focus)
- Add comprehensive API documentation with verified endpoints
- Add complete CUSTOMIZATION guide
- Add project status sections to all major docs
- Clarify MIT license but personal use intent

Created documentation files:
- API.md (70KB) - Complete API reference with live testing
- API-QUICK-REFERENCE.md - Quick command reference
- DEPLOYMENT.md (45KB) - VPS, cloud, manual deployment (no Docker)
- CUSTOMIZATION.md (38KB) - Complete customization guide
- PROJECT-DOCUMENTATION-SUMMARY.md - Complete project overview

This is my personal CV site. While code is public (MIT),
it's designed for my personal use, not as a template.
This commit is contained in:
juanatsap
2025-11-09 13:54:31 +00:00
parent 31dae9fa19
commit 5e132e7ec7
7 changed files with 5122 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+48 -46
View File
@@ -3,12 +3,20 @@
[![Go Version](https://img.shields.io/badge/Go-1.21%2B-00ADD8?logo=go)](https://go.dev/)
[![HTMX](https://img.shields.io/badge/HTMX-1.9.10-3366CC)](https://htmx.org/)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
[![Template](https://img.shields.io/badge/Use-Template-blue.svg)](#-customization)
**Modern, minimal curriculum vitae website** for Juan Andrés Moreno Rubio built with **Go** and **HTMX**.
A professional, bilingual CV site with server-side PDF generation, HTMX interactivity, and a clean paper design aesthetic. Perfect template for developers looking to create their own CV website with modern tech and minimal JavaScript.
## 📌 Project Status
**This is a portfolio/showcase project** demonstrating production-grade Go and HTMX development.
**Template Usage:** Feel free to fork and customize this CV template for your own use following the [CUSTOMIZATION.md](CUSTOMIZATION.md) guide.
**Contributions:** This is a personal CV project and is feature-complete. I'm not actively seeking contributions, but you're welcome to use this as a template for your own CV! If you find a critical security vulnerability, please follow the [SECURITY.md](SECURITY.md) process.
## 📑 Table of Contents
- [Features](#-features)
@@ -36,7 +44,7 @@ A professional, bilingual CV site with server-side PDF generation, HTMX interact
- ✅ **AI Development Section** - Showcases modern AI-assisted development skills
- ✅ **Fast & Lightweight** - Go backend with chromedp for PDF generation
- ✅ **Security Hardened** - CSP headers, XSS protection, secure defaults
- ✅ **Production Ready** - Docker support, systemd service, CI/CD workflows
- ✅ **Production Ready** - Systemd service, CI/CD workflows, deployment guides
- ✅ **Developer Friendly** - Hot reload, clear code structure, comprehensive Makefile
## 📸 Demo
@@ -124,29 +132,19 @@ No code changes needed - just refresh browser!
- **Frontend:** HTMX 1.9.10 (hypermedia-driven interactions)
- **Styling:** Custom CSS with Quicksand font from Google Fonts
- **Data:** JSON files for easy content management
- **Deployment:** Docker, systemd service, GitHub Actions CI/CD
- **Deployment:** Systemd service, manual binary, GitHub Actions CI/CD
## 📚 Documentation
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - System design, data flow, and technical decisions
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - How to contribute (issues, PRs, code style)
- **[DEPLOYMENT.md](DEPLOYMENT.md)** - Production deployment guides (VPS, cloud platforms, systemd)
- **[CUSTOMIZATION.md](CUSTOMIZATION.md)** - Complete guide to customizing this template for your CV
- **[API.md](API.md)** - HTTP endpoints documentation and HTMX integration
- **[SECURITY.md](SECURITY.md)** - Security policy, vulnerability reporting, deployment considerations
- **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** - Community guidelines and standards
- **[LICENSE](LICENSE)** - MIT License
## 🚀 Deployment
This project is production-ready with multiple deployment options:
### Docker Deployment
\`\`\`bash
# Build Docker image
make docker-build
# Run container
make docker-run
\`\`\`
This project is production-ready with multiple deployment options. See **[DEPLOYMENT.md](DEPLOYMENT.md)** for complete guides.
### Systemd Service
@@ -168,6 +166,16 @@ make build
GO_ENV=production ./cv-server
\`\`\`
### Cloud Platforms
Deployment guides available for:
- **Fly.io** - Complete fly.toml configuration
- **Google Cloud Run** - Container deployment
- **AWS ECS** - Task definitions
- **Railway / Render** - Auto-deploy configs
**See [DEPLOYMENT.md](DEPLOYMENT.md) for detailed instructions.**
**Environment Configuration:** Copy `.env.example` to `.env` and customize:
- `PORT` - Server port (default: 1999)
- `GO_ENV` - Environment (development/production)
@@ -177,38 +185,32 @@ GO_ENV=production ./cv-server
## 🎨 Customization
### Update Your CV Content
**Want to use this template for your own CV?** See **[CUSTOMIZATION.md](CUSTOMIZATION.md)** for the complete guide!
1. Edit `data/cv-en.json` and `data/cv-es.json` with your information
2. No code changes required - just refresh the browser!
### Quick Start Customization
### Customize Styling
1. **Update Content:** Edit `data/cv-en.json` and `data/cv-es.json` with your information
2. **Customize Styling:** Modify `static/css/main.css` (colors, fonts, layout)
3. **Adjust Templates:** Edit files in `templates/` directory
4. **Add Sections:** Update `internal/models/cv.go` and JSON files
- **Main styles:** `static/css/main.css`
- **Colors:** Modify CSS variables in `:root` selector
- **Fonts:** Update Google Fonts import in HTML templates
- **Layout:** Edit templates in `templates/` directory
The [CUSTOMIZATION.md](CUSTOMIZATION.md) guide includes:
- Complete JSON schema documentation
- Visual customization (colors, fonts, layout)
- Template modification examples
- Adding new languages
- Advanced customization patterns
### Add New Sections
## 🤝 Using This Template
1. Update the `CV` struct in `internal/models/cv.go`
2. Add content to JSON files in `data/`
3. Update templates in `templates/` to display new sections
**This project is open-source and available for you to use!**
## 🤝 Contributing
✅ **Fork it** and create your own CV
✅ **Customize** following [CUSTOMIZATION.md](CUSTOMIZATION.md)
✅ **Star it** ⭐ if you find it useful
✅ **Share it** with others who might benefit
Contributions are welcome! Whether it's:
- 🐛 Bug reports
- 💡 Feature suggestions
- 📝 Documentation improvements
- 🔧 Code contributions
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:
- Submitting issues
- Creating pull requests
- Code style and testing requirements
- Development workflow
**Note:** This is a personal portfolio project. I'm not actively accepting contributions, but you're free to use it as a template for your own CV!
## 📄 License
@@ -216,11 +218,11 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
**TL;DR:** You can use this template for your own CV site, modify it, and distribute it. Just keep the original copyright notice.
## 💬 Support
## 💬 Questions or Issues?
- **Issues:** [GitHub Issues](https://github.com/yourusername/cv/issues) for bug reports and feature requests
- **Discussions:** [GitHub Discussions](https://github.com/yourusername/cv/discussions) for questions and ideas
- **Security:** See [SECURITY.md](SECURITY.md) for reporting security vulnerabilities
- **Questions:** Feel free to fork and modify - this is a template!
- **Security Issues:** See [SECURITY.md](SECURITY.md) for reporting security vulnerabilities
- **Documentation:** Check [CUSTOMIZATION.md](CUSTOMIZATION.md) and [DEPLOYMENT.md](DEPLOYMENT.md)
## 🙏 Acknowledgments