mirror of
https://github.com/olehomelchenko/stat230-2025-portfolio-template.git
synced 2025-12-21 21:22:28 +00:00
77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# Data Visualization Portfolio - Quick Start Guide
|
|
|
|
This is a quick-start guide to help you get started with the portfolio template.
|
|
|
|
**📖 For complete requirements, grading rubric, and detailed instructions, see `docs/ASSIGNMENT.md`**
|
|
|
|
## 📋 Quick Overview
|
|
|
|
**What to submit by Week 8:**
|
|
- ZIP archive with `index.html`, datasets, and AI documentation (if applicable)
|
|
- 5-7 minute video presentation (link embedded in your portfolio)
|
|
|
|
**What to create:**
|
|
- Portfolio with minimum 5 visualizations exploring a unified theme
|
|
- Each visualization needs context, design rationale, insights, and source citation
|
|
|
|
**File naming:** `Portfolio_[LastName]_[FirstName].zip`
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start (3 Steps)
|
|
|
|
### Step 1: Get the Template
|
|
- Download or clone this repository to your computer
|
|
- Open the folder in VS Code (or your preferred editor)
|
|
|
|
### Step 2: Edit `index.html`
|
|
- Replace all `[placeholders]` with your content
|
|
- Add your visualizations (examples for Vega-Lite, Tableau, and images included)
|
|
- Test by opening `index.html` in your browser
|
|
|
|
### Step 3: Submit
|
|
- Create ZIP: `Portfolio_[LastName]_[FirstName].zip`
|
|
- Include: `index.html`, all datasets, AI documentation (if applicable)
|
|
- Submit by Week 8
|
|
|
|
---
|
|
|
|
## 💡 How to Use the Template
|
|
|
|
### Adding Visualizations
|
|
|
|
The template includes **3 examples** you can copy:
|
|
|
|
1. **Vega-Lite:** Find `<script>` with `var spec1 = {...}`, replace with your spec
|
|
2. **Tableau Public:** Publish to YOUR account, get embed code, paste into HTML
|
|
3. **Python/R/Images:** Export as PNG/SVG, save in same folder, use `<img>` tag
|
|
|
|
**Add more:** Copy an entire `<article>` block and modify it
|
|
|
|
### What to Include for Each Visualization
|
|
|
|
The template has placeholders for:
|
|
- **Context & Question:** What are you exploring and why?
|
|
- **Design Decisions:** Why this chart type? What encodings? What tradeoffs?
|
|
- **Key Insights:** What did you discover?
|
|
- **Data Source:** Where is the data from? (include link)
|
|
|
|
**See `docs/ASSIGNMENT.md` for detailed requirements and the visualization quality checklist**
|
|
|
|
---
|
|
|
|
## 🆘 Need Help?
|
|
|
|
### Get Support
|
|
**Oleh Omelchenko**
|
|
- Slack (preferred for quick questions)
|
|
- Office Hours: Wednesday 16:00-18:00, KSE Campus
|
|
- Email: o_omelchenko@kse.org.ua
|
|
|
|
---
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **`docs/ASSIGNMENT.md`** - Complete requirements, grading rubric, and policies
|
|
- **`docs/PUBLISHING.md`** - Optional guide for publishing to GitHub Pages (not graded)
|