diff --git a/README.md b/README.md index b870034..39ae2fe 100644 --- a/README.md +++ b/README.md @@ -1,311 +1,60 @@ -# README +# NGO Website — ODOO4projects -Important: Update this README with every commit. +**Project:** NGO marketing homepage and blog +**URL:** [ngo.odoo4projects.com](https://ngo.odoo4projects.com) +**Stack:** Static HTML · Tailwind CSS · Vanilla JS -Repository purpose -- Project: NGO public website using Odoo-focused messaging and Odoo4Projects hosting service. -- Goal: Fast, accessible marketing homepage and blog that ranks well, highlights transparency and minimal admin for NGOs, and promotes donor acquisition and retention. +--- -Repository rules -- Blog posts are saved in blog.json (do not create separate backup files). -- Do not create backups in the repo. +## Repository Rules -CI: -- CI: run linting, Tailwind build, accessibility checks, basic SEO checks, performance budget (build must verify page size and critical render time). (Keep CI config outside this README; note these checks are required.) +- Blog posts live in `blog.json` — do not create separate backup files. +- No backup files in the repo. +- Update this README with every commit. -Main Page Blocks (ordered) -1. Hero - - Headline: Transparent -giving. -Minimal -admin. -Big -impact. - - Subheadline: Manage -donors, -communicate -transparently, -and -focus -on -impact -— -Odoo -made -simple -for -NGOs. - - Primary CTA: Donate -/ -Support and secondary CTA: See -donor -management -2. Trust & Numbers bar - - Donor count, funds raised, projects completed, partner logos -3. How it works (3 steps) - - Step 1: Set up in minutes (little admin) - - Step 2: Track donations & communicate (donor communication) - - Step 3: Report impact (transparent reporting) -4. Features (highlighted cards) - - Donor Management (CRM + gift history) - - Easy Communication (email, receipts, automated updates) - - Transparent Reporting (dashboards, exports for donors) - - Low Admin (templates, automation, minimal data entry) - - Security & Compliance -5. Impact Stories / Testimonials - - Short stories with photos and metrics -6. Blog highlights - - Link to blog page, featured posts -7. Call to Action block - - Repeat primary CTA with trust indicators -8. Footer - - Contact, legal, social links, languages +--- -Languages: -- Default: English -- Additional: Spanish (es), French (fr) — prepare for translation-ready content +## Page Structure -Technology Stack: -- Tailwind CSS. Static-first, optimized HTML, semantic markup. +| # | Block | Purpose | +|---|-------|---------| +| 1 | **Hero** | Headline, subheadline, free-trial CTA, key stats | +| 2 | **Hot NGO Topics** | Three focused topic cards (transparency, communications, fundraising) | +| 3 | **Blog** | Latest articles loaded dynamically from `blog.json` | +| 4 | **Sign Up — Free Trial** | Email signup form, 4-week free trial, no credit card | +| 5 | **Have a Meeting** | 30-minute consultation booking via Google Calendar | -SEO & Performance goals: -- Fast page that ranks well: semantic HTML, structured data (schema.org), descriptive meta titles and descriptions, sitemap, robots.txt, optimized images (modern formats), critical CSS inlined, defer non-critical JS. -- Focus keywords: NGO donor management, transparent donations, Odoo for NGOs, donor communication, minimal admin for charities +--- -Suggested meta and headings (to include on homepage): -- Meta title (homepage): Odoo -for -NGOs -— -Transparent -donor -management -with -minimal -admin -- Meta description: Manage -donors, -communicate -transparently, -and -report -impact -with -minimal -admin. -Odoo -solutions -tailored -for -NGOs -— -fast, -secure, -and -donor-friendly. -- H1: Transparent -donor -management -with -minimal -admin -- H2 examples: How -Odoo -simplifies -donor -management, Features: -Donor -CRM, -automated -communication, -impact -reporting, Stories -from -our -partners +## CI Checks (required on every push) -Suggested CTAs (text variations): -- Primary: Support -now / Donate -- Secondary: See -donor -management / Schedule -a -demo -- Micro CTA: Download -impact -report +- **HTML lint** — valid markup, no broken anchors +- **JS lint** — no errors, no `console.error` left in production paths +- **Tailwind build** — `npx tailwindcss -i ./src/input.css -o ./assets/site.css --minify` must exit 0 +- **Corporate design compliance:** + - No CSS gradients — `gradient`, `bg-*-gradient`, `linear-gradient`, `radial-gradient` are forbidden + - No CSS animations or keyframes — `animate-*`, `@keyframes`, transform-based `hover:translate-*` are forbidden + - No blur or glassmorphism effects — `backdrop-blur`, `backdrop-filter` are forbidden + - Colors must use the approved brand palette only: `brand-ink · brand-primary · brand-accent · brand-sunrise · brand-emerald · brand-snow · brand-smoke` + - Images must be served from `odoo4projects.com`, `images.unsplash.com`, or local `assets/` +- **Accessibility** — heading hierarchy (one `