Orthodox Pilgrimage

Orthodox Pilgrimage is a modern, community-driven web application designed to help the faithful locate and venerate the sacred relics of Orthodox Saints across North America. It provides an interactive, mobile-friendly map to discover holy sites, monasteries, and cathedrals that house these sacred treasures.

🚀 Features

• Interactive Map: Powered by OpenLayers, providing a fluid experience for discovering churches.
• Deep Linking: Every church and saint has its own URL, making it easy to share specific locations.
• Mobile First: Optimized for use on the go with a "bottom sheet" interface for church details.
• Fast & Efficient: Built with Go and HTMX for a snappy, "Single Page App" feel without the heavy JavaScript overhead.

🛠 Tech Stack

• Backend: Go (standard library net/http)
• Database: SQLite with sqlc for type-safe queries.
• Frontend: HTML Templates, HTMX, OpenLayers (Maps), and Vanilla CSS.
• Caching: Strategy optimized for Cloudflare Edge Caching.

🏃 Getting Started

Prerequisites

• Go 1.22+
• make
• sqlc (for regenerating database code) make install/tools

Local Development

1. Clone the repository:

   git clone https://github.com/edwlarkey/orthodoxpilgrimage.git
   cd orthodoxpilgrimage

2. Build the application:

   make build

3. Run the server:

   ./bin/orthodoxpilgrimage

   The server will start on :8080. The database (orthodox_pilgrimage.db) is automatically created and migrated on startup. Use the --seed flag to populate it from data.json.

🤝 Contributing

We welcome contributions of all kinds, from bug fixes and feature requests to data updates.

Contributing Data Updates

The "Source of Truth" for the application's data is a single JSON file. You don't need to know how to code to help us keep the map accurate!

File Location: internal/app/data/data.json

To add a new church or saint:

1. Locate internal/app/data/data.json.
2. Add a new entry to the saints array or churches array.
3. Ensure saint_slug in the church's relics list matches the slug defined in the saints section.
4. Submit a Pull Request with your changes.

Contributing Code

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

Styling Note: We prefer Vanilla CSS for all styling. Please avoid adding large CSS frameworks.

📜 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.

---

Help us keep this map accurate. If you have corrections or new information, reach out at info@orthodoxpilgrimage.com.