Skip to content
Merged
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
85 changes: 72 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,90 @@
# Deanery

A Django-based system for non-secular institutions.
A white‑label full‑stack platform for cooperative, community, and faith‑based organisations—tailored here for faith centres.

## 📋 Project Management

This repository uses **GitHub Project Boards** with the **MoSCoW prioritization method** and **Kanban workflow**.

### 🏷️ Priority Labels
## Overview

- `MUST HAVE` (🟢) - Critical functionality essential for the product
- `SHOULD HAVE` (🟡) - Important functionality that adds significant value
- `COULD HAVE` (🟠) - Nice-to-have functionality that would be beneficial
- `WONT HAVE` (🔴) - Functionality deferred to future releases
This project provides a modular web platform to manage community content, events, churches/locations, maps, and communications. It is designed to be re‑skinned and reused across organisations while keeping core features consistent.

### 📖 Contributing
## Project Map

When creating issues or user stories:
- **config/** — Django project configuration and settings
- **home/** — Core pages, newsletter signup, events, churches, contact
- **map/** — Map views and templates
- **theme/** — Tailwind/DaisyUI theme, templates, static assets
- **docs/** — CSV data sources for churches
- **media/** — User‑uploaded files (images)
- **staticfiles/** — Collected static output (dev/prod)

1. Use the **📖 User Story** template for new features
2. Use the **🐛 Bug Report** template for issues
3. Always assign a MoSCoW priority label
4. Follow the acceptance criteria format: AS A...I WANT TO...SO THAT...
## Tech Stack

For detailed setup instructions, see [Project Board Setup Guide](.github/PROJECT_BOARD_SETUP.md).
- **Backend:** Django 5
- **Frontend:** Tailwind CSS + DaisyUI
- **Database:** SQLite (local) / PostgreSQL (production via `DATABASE_URL`)
- **Maps:** Google Maps API (optional)
- **Deployment:** Gunicorn + WhiteNoise

## UI/UX

- Clean, accessible layout with a fixed header and footer
- Tailwind/DaisyUI theming for consistent components
- Responsive layouts for events and church listings
- Newsletter modal and inline signup patterns

## Colour Scheme

| Fern Green | Cal Poly Green | Black | Night | Penn Red |
| :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: |
| ![#608351](https://via.placeholder.com/30/608351/FFFFFF?text=+) `#608351` | ![#2D3D26](https://via.placeholder.com/30/2D3D26/FFFFFF?text=+) `#2D3D26` | ![#000000](https://via.placeholder.com/30/000000/FFFFFF?text=+) `#000000` | ![#10150D](https://via.placeholder.com/30/10150D/FFFFFF?text=+) `#10150D` | ![#941100](https://via.placeholder.com/30/941100/FFFFFF?text=+) `#941100` |

## Features

- Event management (create, edit, delete, feature)
- Church directory with contact and location info
- Newsletter subscription with double opt‑in
- Map view for locations
- Contact form with email delivery

## Quickstart

*(Add setup steps here)*

## Configuration

*(Add environment/configuration notes here)*

## Environment Variables

*(Add required variables here)*

## Running Tests

*(Add test commands here)*

## Deployment

*(Add deployment steps here)*

## Screenshots

*(Add screenshots here)*

## Roadmap

*(Add roadmap here)*

## Contributing

*(Add contributing guidelines here)*

## License

*(Add license info here)*

## Thanks

*(Add acknowledgements here)*
8 changes: 6 additions & 2 deletions config/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
"127.0.0.1",
"localhost",
'74.220.49.0/24',
'74.220.57.0/24'
'74.220.57.0/24',
"https://white-label-fullstack-deanery.onrender.com",
"white-label-fullstack-deanery.onrender.com",
]

CSRF_TRUSTED_ORIGINS = [
Expand All @@ -34,7 +36,9 @@
'74.220.49.0/24',
'74.220.57.0/24',
'http://127.0.0.1:8000',
'http://localhost:8000'
'http://localhost:8000',
"https://white-label-fullstack-deanery.onrender.com",
"white-label-fullstack-deanery.onrender.com",
]

# Database - Single, clear definition
Expand Down