DRP_Sajidaat/README.md

62 lines
2.2 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Sajidaat (سَاجِدَات) Prayer Space Finder
**Find your peace. Find your place.**
This project was developed as part of the _"Designing for Real People"_ module for the second-year Computing course at Imperial College London. The brief was to identify a real-world problem faced by a specific community and develop a human-centered digital solution.
---
## 📖 Table of Contents
- [❔ Problem](#-the-problem)
- [✅ Solution](#-the-solution)
- [✨ Core Features](#-core-features)
- [🛠️ Tech Stack](#-tech-stack)
- [🚀 Getting Started](#-getting-started)
---
## ❔ The Problem
For many Muslims, especially women, finding a suitable prayer space while away from home is a source of anxiety. Standard mapping tools lack crucial details like the availability of a women's section or its cleanliness, leading to wasted time and forcing individuals to pray in unsuitable public spaces.
---
## ✅ The Solution
**Sajidaat** is a community-driven mobile app that empowers Muslims to find and verify suitable prayer spaces with confidence. The name "Sajidaat" (سَاجِدَات) is Arabic for "women in prostration," signifying our focus on this challenge. By transforming private frustrations into public, actionable feedback, Sajidaat not only helps individuals but also encourages the development of more inclusive community spaces.
---
## ✨ Core Features
- 📍 **Interactive Map & Distance-Sorted List**
- ♀️ **Filtering:** For Womens Spaces, Wudu, Ratings, etc.
-**Community-Driven Ratings & Reviews**
- 🖼️ **Image Gallery** with Notes for each location
- **Crowdsourced Spaces:** Users can add new locations
---
## 🛠️ Tech Stack
- **Framework:** React Native with Expo
- **Frontend Language:** TypeScript
- **Prototyping & Mobile Runtime:** Expo Go
- **Mapping:** `react-native-maps` (Google Maps)
- **Builds:** EAS Build
- **Backend Server:** Golang (Gin + GORM)
- **Database:** PostgreSQL
- **Environment & Deployment:** Docker for prototyping and portability
---
## 🚀 Getting Started
To run this project locally:
1. Clone the repository
2. Run `npm install` (or `yarn install`)
3. Create a `.env` file in the root directory with your API keys
5. Start the server with: npx expo start