IranRevolution2026

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #golang #android #machine-learning #docker #macos #windows #awesome #vue #openai #open-source

IranRevolution2026

(★ 12)

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

IranRevolution2026 Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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:
   ```bash
   cp .env.example .env
   ```
2. Add your OpenRouter API key to the `.env` file:
   ```env
   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
```bash
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:
```json
{
  "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](CARE_PROTOCOL.md); open an issue for corrections or removals.

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) and our [Care Protocol](CARE_PROTOCOL.md) 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
- [atakhadiviom](https://github.com/atakhadiviom) - Lead Developer & Maintainer
- [Davoud Ramezani Kermani](https://github.com/Davoudr) - Full-stack Developer & Core Contributor
- [Sadegh Rizi](https://github.com/sadegh-rizi) - PDF Poster Concept & Original Idea

## License
MIT. See [LICENSE](LICENSE).

IranRevolution2026

IranRevolution2026 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

IranRevolution2026

IranRevolution2026 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README