Professional LaTeX Report Template

Professional, modular LaTeX template for internship reports, thesis, and academic documents.
Modern typography • Automated compilation • Cross-platform compatibility

📖 Complete Tutorial • 🚀 Quick Start • 🔧 Commands • 🤝 Contributing

---

✨ Key Features

• Professional Typography - Times New Roman, optimized spacing, clean layouts
• Automated Compilation - Python scripts with auto-watch mode
• Modular Architecture - Separated configuration, content, and templates
• Cross-Platform - Windows, macOS, Linux, and Overleaf compatible
• Smart References - Automatic numbering and hyperlinked cross-references
• Academic Standards - Follows international formatting guidelines

📸 Preview

See Sample tutorial document based on this template here.

Template Screenshots

Title Page	Chapter Layout
Tables and Figures	Bibliography

🛠️ Tech Stack

This template leverages modern LaTeX packages and tools for optimal document production:

↕️ Click here to Show/Hide Tech Stack

Category	Technology	Role
Document Engine		Document typesetting
		Compilation engine
		Bibliography processor
Typography		Font system
		Icon system
		Page layout
Core Packages		Bibliography management
		PDF features
		Advanced boxes
		Graphics engine
Development Tools		Build automation
		Development environment
		Version control
Online Platforms		Cloud editing
		Repository hosting
Diagram Tools		UML diagrams
		Flowcharts
		Technical drawings

📋 Prerequisites

For Online Use:

• Overleaf account (free)

For Local Use:

• LaTeX Distribution (TeX Live 2023+ or MiKTeX)
• Python 3.8+
• GNU Make 4.4+
• Git

🚀 Quick Start

Option 1: Use Online (Easiest)

1. Download this repository as ZIP
2. Upload to Overleaf
3. Set compiler to pdfLaTeX
4. Edit metadata.tex with your information
5. Start writing in content/chapters/

Option 2: Local Development

# Clone and setup
git clone https://github.com/sikatikenmogne/latex-report-template.git
cd latex-report-template

# Check environment
python scripts/check.py

# Compile document
python scripts/compile.py

# Watch for changes (auto-compile)
python scripts/watch.py

🔧 Commands

Command	Description
make build	Compile the document
make watch	Auto-compile on file changes
make release TAG=v1.0.0	Create new release
python scripts/check.py	Validate environment
python scripts/release.py list	List all releases

📁 Project Structure

latex-report-template/
├── main.tex                    # Main document
├── metadata.tex                # Your information here
├── titlepage.tex               # Custom title page
├── internshipreport.cls        # Document class
├── config/                     # Template configuration
│   ├── colors.tex              # Color scheme
│   ├── packages.tex            # LaTeX packages
│   └── style.tex               # Typography
├── content/                    # Your content
│   ├── chapters/               # Main chapters
│   └── frontmatter/            # TOC, abstract, etc.
├── scripts/                    # Build automation
│   ├── compile.py              # Compilation script
│   ├── watch.py                # Auto-compiler
│   └── release.py              # Release management
└── assets/                     # Images and logos
    ├── images/                 # Your figures
    └── logos/                  # Institution logos

📖 Documentation

📘 Complete Guide: TUTORIAL.md - Comprehensive documentation with examples

⚡ Quick References:

• Installation Guide
• Configuration
• Writing Content

🎯 Quick Configuration

Edit metadata.tex with your information:

\renewcommand{\reporttitle}{Your Report Title}
\renewcommand{\reportauthor}{Your Name}
\renewcommand{\company}{Company Name}
\renewcommand{\university}{Your University}
\renewcommand{\defensedate}{Date}

That's it! The template handles the rest automatically.

🚀 Release Management

Create automatic releases with PDF generation:

# Create release (any tag format)
python scripts/release.py create v1.0.0
python scripts/release.py create final
python scripts/release.py create 2024-12-19

# Or with make
make release TAG=v1.0.0

GitHub Actions automatically compiles LaTeX and creates releases with PDF attachments.

🎨 Customization

Colors

Edit config/colors.tex:

\definecolor{primarycolor}{RGB}{25,118,210}
\definecolor{secondarycolor}{RGB}{0,82,147}

Environments

Use custom environments:

\begin{infobox}[Title]
Important information here
\end{infobox}

\begin{successbox}
Achievement or positive result
\end{successbox}

Commands

Special text formatting:

\important{highlighted text}
\technology{React.js}
\company{Microsoft}

🤝 Contributing

Contributions welcome! Please follow our guidelines for the best experience.

Quick Contribution

1. Fork the repository
2. Create feature branch: git checkout -b feature/amazing-feature
3. Commit changes: git commit -m 'Add amazing feature'
4. Push and create Pull Request

Reporting Issues

• 🐛 Bug Reports
• ✨ Feature Requests

📄 License

This project is licensed under the MIT License - see LICENSE for details.

TL;DR: Free to use, modify, and distribute for any purpose.

🆘 Support

Need Help?

• 📖 Read the Tutorial
• 💬 GitHub Discussions
• 🐛 Report Issues
• 📧 Email Support

Common Solutions:

• Compilation errors → python scripts/check.py
• Missing packages → Install full LaTeX distribution
• VS Code setup → Install LaTeX Workshop extension

---

⭐ Found this useful? Give it a star!

Star this repo • Fork it • Download ZIP

Built with ❤️ for the latex lovers