Skip to content

atakhadiviom/IranRevolution2026

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

718 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Iran Memorial

Interactive, open-source memorial website dedicated to commemorating individuals in Iran who lost their lives during the revolution.

Features

  • Responsive, vector-based map interface with interactive red markers
  • Click a marker to view biography, date/location, media, and testimonials
  • Search and filtering by name, city, and year
  • Accessibility-first design meeting WCAG 2.1 AA principles
  • Privacy-friendly: no analytics, no tracking, no cookies
  • Multilingual support (Persian and English)
  • Admin submission tool generating validated JSON for moderated entries

Environment Setup

Local Development

  1. Create a .env file in the root directory:
    cp .env.example .env
  2. Add your OpenRouter API key to the .env file:
    VITE_OPENROUTER_API_KEY=sk-or-v1-...

GitHub Deployment (Secure)

To use the AI features on your deployed site, you must add your API key to GitHub Secrets:

  1. Go to your repository on GitHub.
  2. Click Settings > Secrets and variables > Actions.
  3. Click New repository secret.
  4. Name: VITE_OPENROUTER_API_KEY.
  5. Value: Your OpenRouter API key.
  6. Your CI/CD workflow will now securely inject this key during the build process.

Tech Stack

  • HTML5, CSS3, TypeScript, Vite
  • Leaflet.js for interactive mapping
  • Static JSON data model stored in public/data/memorials.json

Getting Started

npm install
npm run dev

Open the local URL shown and visit /admin.html for the submission tool.

Data Schema

Memorial entries follow this shape:

{
  "id": "unique-id",
  "name": "Full Name",
  "city": "City",
  "location": "City, Iran",
  "date": "YYYY-MM-DD",
  "coords": { "lat": 35.6892, "lon": 51.3890 },
  "bio": "Optional biography",
  "testimonials": ["Optional testimonial lines"],
  "media": { "photo": "/path.jpg", "video": "/path.mp4" }
}

Accessibility

  • Keyboard accessible markers and detail panel
  • Sufficient color contrast and focus indicators
  • Semantic landmarks (header, main, aside, footer) and ARIA labels

Privacy

See public/privacy.html. No trackers or cookies. Content is community-moderated according to our Care, Visibility & Data Protocol; open an issue for corrections or removals.

Contributing

See CONTRIBUTING.md and our Care Protocol for guidelines. Issues and PRs welcome.

CI/CD

Pushes to main trigger build and deployment to GitHub Pages via Actions (.github/workflows/deploy.yml).

Contributors

License

MIT. See LICENSE.

About

Interactive, open-source memorial website dedicated to commemorating individuals in Iran who lost their lives during the revolution.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors