Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# ideas
Ideas board
# Ideas Board

Welcome to the Ummah Build Ideas repository! This is a collection of project ideas aimed at serving the Muslim community.

## 📋 How It Works

Each idea is documented as a separate markdown file in the [`ideas/`](./ideas/) directory. These ideas can be linked to GitHub Projects to track their progress and development.

## 🎯 Current Ideas

- [🗄️ Mosque Database](./ideas/idea-003-mosque-database.md) - Open API for mosque information and prayer times
- [📚 Quran Study Platform](./ideas/idea-002-quran-study-platform.md) - Interactive Quran study and memorization platform
- [📱 Halal Food Finder](./ideas/idea-001-halal-food-finder.md) - Find halal restaurants and stores nearby

## 🚀 Contributing an Idea

1. Create a new markdown file in the `ideas/` directory following the naming convention: `idea-XXX-name.md`
2. Use the template provided in [`ideas/README.md`](./ideas/README.md)
3. Include: title with emoji, status, description, and requirements
4. Submit a pull request

## 📊 Linking to GitHub Projects

Each idea can be linked to a GitHub Project board for tracking:
1. Create or open a GitHub Project
2. Add issues and tasks related to the idea
3. Reference the idea markdown file in issue descriptions
4. Track progress using project board columns

## Status Legend

- 🔵 `ideating` - Initial concept stage
- 🟡 `planning` - Detailed planning in progress
- 🟢 `in-progress` - Active development
- ✅ `completed` - Finished
- ⏸️ `on-hold` - Paused temporarily
45 changes: 45 additions & 0 deletions ideas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Ideas Template

Use this template to create new ideas.

## Markdown Structure

Each idea should be a separate markdown file in the `ideas/` directory with the naming convention: `idea-XXX-name.md`

### Template Format:

```markdown
# 🎯 [Idea Title]

**Status:** `ideating|planning|in-progress|completed|on-hold`

## Description

Brief description of the idea - what problem does it solve, what is the vision?

## Requirements

- List of requirements
- Feature requests
- Technical needs
- Resources needed
```

## Status Values

- `ideating` - Initial concept stage
- `planning` - Detailed planning in progress
- `in-progress` - Active development
- `completed` - Finished
- `on-hold` - Paused temporarily

## Emoji Guide

Use emojis to make ideas visually distinctive:
- 🗄️ Database/Data projects
- 🕌 Islamic/Mosque related
- 📱 Mobile apps
- 🌐 Web applications
- 🔧 Tools and utilities
- 📚 Educational projects
- 🤝 Community projects
19 changes: 19 additions & 0 deletions ideas/idea-001-halal-food-finder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 📱 Halal Food Finder

**Status:** `ideating`

## Description

Mobile and web application to help Muslims find halal restaurants, grocery stores, and food products in their area.

## Requirements

- User-friendly mobile interface
- Geolocation-based search
- Restaurant and store database
- User reviews and ratings
- Halal certification verification
- Photo uploads for menus and stores
- Filter by cuisine type
- Prayer space availability indicator
- Integration with mapping services
20 changes: 20 additions & 0 deletions ideas/idea-002-quran-study-platform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 📚 Quran Study Platform

**Status:** `ideating`

## Description

Interactive platform for studying and memorizing the Quran with features for tracking progress, understanding tafsir (interpretation), and connecting with study groups.

## Requirements

- Complete Quran text with multiple translations
- Audio recitations by various reciters
- Tafsir (interpretation) from recognized scholars
- Memorization tracking tools
- Progress dashboard
- Study groups and social features
- Daily verse notifications
- Bookmarking and note-taking
- Search functionality across translations and tafsir
- Offline mode for mobile apps
16 changes: 16 additions & 0 deletions ideas/idea-003-mosque-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 🗄️ Mosque Database

**Status:** `ideating`

## Description

Database of every mosque, their prayer times, Khutbah information as open API.

## Requirements

- Comprehensive mosque information database
- Prayer times integration
- Khutbah (sermon) schedules and information
- Open API for public access
- Geolocation support for finding nearby mosques
- Regular updates for prayer time changes