Complete developer documentation, setup guides, API references, PWA tutorials, and brand integration instructions for the LYF Mail privacy-first digital wellness platform and all open-source tools.
"Knowledge is not just information — it's the spark that lights the path to growth."
The official knowledge hub for LYF Mail — India's privacy-first digital wellness platform.
LYF Mail Docs is the official documentation repository for the entire LYF Mail ecosystem — a comprehensive knowledge hub covering installation guides, Progressive Web App (PWA) setup, technical references, developer tutorials, brand integration instructions, and SEO best practices for LYF Mail and all its open-source subprojects.
This repository serves as the central source of truth for:
- 🏗️ Developers building with or contributing to LYF Mail tools.
- 🎨 Designers integrating LYF Mail brand assets into their projects.
- 📰 Content creators using LYF Mail newsletters and guides.
- 🛠️ System administrators deploying LYF Mail PWAs on VPS, shared hosting, or edge networks.
- 🔍 SEO professionals optimizing sites within the LYF Mail subdomain architecture.
Built by LYF Mail, a privacy-first digital wellness platform serving 50,000+ subscribers across India since 2020, LYF Mail Docs extends our mission of "Every Choice Shapes Tomorrow" into open knowledge sharing, developer empowerment, and technical transparency.
👉 Access the live documentation hub: docs.lyfmail.com
The live site covers five core knowledge pillars:
| Category | Topics Covered | Live URL |
|---|---|---|
| Health & Wellness | Fitness, nutrition, mental health, holistic living, preventive care. | https://docs.lyfmail.com/health-wellness |
| Business & Investment / Finance | Entrepreneurship, financial literacy, investing, digital business. | https://docs.lyfmail.com/financing |
| Employment & Career | Resume writing, interviews, upskilling, workplace productivity. | https://docs.lyfmail.com/career |
| Arts & Creativity / Entertainment | Visual arts, creative writing, design thinking, media trends. | https://docs.lyfmail.com/unlocking-creativity-expression-and-culture |
| Self-Help / Intuition | Mindfulness, confidence building, relationships, positive mindset. | https://docs.lyfmail.com/self-help-intuition |
This repository contains comprehensive documentation organized into the following sections:
- Overview — What is LYF Mail and the ecosystem architecture?
- System Requirements — Browser support, server requirements, minimum specs.
- Quick Start — Deploy your first LYF Mail PWA in under 10 minutes.
- Architecture Overview — Understanding the subdomain model, CDN strategy, and edge deployment.
- File Structure — Standard LYF Mail PWA directory layout.
- Manifest Configuration —
manifest.jsonbest practices for installability. - Service Worker — Cache strategies, offline fallbacks, background sync.
- Offline Mode — Designing resilient experiences for low-connectivity environments.
- Performance Optimization — Core Web Vitals, lazy loading, image optimization.
- CyberPanel Deployment — Step-by-step LYF Mail PWA deployment on CyberPanel.
- OpenLiteSpeed Setup — Configuration for high-performance static hosting.
- Cloudflare Pages — Edge deployment with automatic CI/CD.
- GitHub Pages — Free static hosting for open-source project documentation.
- VPS Deployment — Self-hosted deployment on Ubuntu/Debian with Nginx.
- Shared Hosting — cPanel and DirectAdmin deployment guides.
- API Documentation — Future API endpoints and integration patterns.
- Caching Strategies — Service worker caching, CDN configuration, cache invalidation.
- Security Headers — HSTS, CSP, X-Frame-Options, and other security best practices.
- Web Performance — Lighthouse optimization, bundle analysis, resource hints.
- Accessibility (a11y) — WCAG 2.1 AA compliance guidelines for all LYF Mail projects.
- Integrating LYF Mail Components — How to embed newsletters, signup forms, and tools.
- Building Privacy-First PWAs — Patterns from the LYF Mail open-source toolkit.
- Subdomain SEO Strategy — How LYF Mail uses subdomains for targeted content discovery.
- Zero-Backend Architecture — Building apps with localStorage, IndexedDB, and Web Crypto API.
- Homomorphic Encryption Basics — Introduction to privacy-preserving computation (as used in Ebb).
- Logo Usage — Correct and incorrect logo applications, minimum sizes, clear space.
- Color Palette — Primary, secondary, and accent colors with hex/RGB values.
- Typography — Font families, weights, and hierarchy for LYF Mail branded content.
- UI Guidelines — Button styles, form elements, card components, spacing systems.
- Brand Voice — Tone, terminology, and messaging guidelines for LYF Mail communications.
- Indexing Strategy — How LYF Mail structures content for maximum search visibility.
- Sitemap Configuration — XML sitemaps for multi-subdomain ecosystems.
- Internal Linking — Cross-linking strategy between lyfmail.com and subdomains.
- Schema.org Markup — Structured data for articles, FAQs, organizations, and apps.
- Subdomain SEO — Best practices for health.signup.lyfmail.com, signals.lyfmail.com, etc.
- Common Errors — Deployment issues, service worker failures, caching problems.
- Performance Fixes — Slow load times, large bundle sizes, render-blocking resources.
- SEO Issues — Indexing problems, duplicate content, canonical tag configuration.
- Security Fixes — CSP violations, mixed content warnings, certificate issues.
The LYF Mail platform uses a strategic subdomain architecture for targeted SEO, content organization, and developer accessibility:
| Subdomain | Purpose | Live URL |
|---|---|---|
lyfmail.com |
Main website — newsletters, guides, brand hub. | lyfmail.com |
app.lyfmail.com |
Official Progressive Web App. | app.lyfmail.com |
docs.lyfmail.com |
Documentation hub (this repository). | docs.lyfmail.com |
health.signup.lyfmail.com |
Health newsletter signup landing. | health.signup.lyfmail.com |
financing.signup.lyfmail.com |
Finance newsletter signup landing. | financing.signup.lyfmail.com |
career.signup.lyfmail.com |
Career newsletter signup landing. | career.signup.lyfmail.com |
creativity.signup.lyfmail.com |
Creativity newsletter signup landing. | creativity.signup.lyfmail.com |
intuition.signup.lyfmail.com |
Personal development signup landing. | intuition.signup.lyfmail.com |
trustlens.lyfmail.com |
Misinformation detection tool. | trustlens.lyfmail.com |
signals.lyfmail.com |
Privacy-first analytics. | signals.lyfmail.com |
ebb.lyfmail.com |
Encrypted period tracker. | ebb.lyfmail.com |
lyfsos.lyfmail.com |
Offline emergency app. | lyfsos.lyfmail.com |
pdpr.lyfmail.com |
Dark pattern registry. | pdpr.lyfmail.com |
together.lyfmail.com |
Therapeutic silence app. | together.lyfmail.com |
support.lyfmail.com |
Help center & support. | support.lyfmail.com |
git clone https://github.com/lyfmail-official/lyfmail-docs.git
cd lyfmail-docsAll documentation files are simple Markdown (.md) files for easy editing:
# Browse getting started guides
cat getting-started/README.md
# Review PWA setup instructions
cat pwa-setup/README.md
# Check deployment guides
cat deployment/cyberpanel.md# Using Python
python3 -m http.server 8080
# Using Node.js
npx serve .
# Open http://localhost:8080See CONTRIBUTING.md for contribution guidelines.
lyfmail-docs/
├── getting-started/
│ ├── README.md
│
├── pwa-setup/
│ ├── README.md
├── deployment/
│ ├── README.md
│
├── developer-tutorials/
│ ├── README.md
│
├── seo-content-structure/
│ ├── README.md
├── .github/
│ └── workflows/
│ └── deploy.yml # GitHub Actions deployment to docs.lyfmail.com
├── LICENSE
├── README.md
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
└── SECURITY.md
This repository serves as:
- ✅ A public documentation base — openly accessible knowledge for all users and developers.
- ✅ A developer-friendly resource — clear, practical guides with copy-paste code examples.
- ✅ A brand authority booster — comprehensive documentation that establishes LYF Mail as a trusted digital wellness authority.
- ✅ An SEO-indexable knowledge hub — structured content that drives organic traffic to lyfmail.com and all subdomains.
- ✅ A contribution gateway — welcoming developers, writers, and educators to improve the ecosystem.
LYF Mail Docs is part of the LYF Mail ecosystem — nine free, open-source privacy tools and a digital wellness platform from Varanasi, India. Explore our projects:
| Project | Description | Live App | Repository |
|---|---|---|---|
| LYF Mail | Privacy-first newsletters for health, wealth, career & mindfulness. | lyfmail.com | lyfmail |
| TrustLens | Detect misinformation before you share. Privacy-first credibility analysis. | trustlens.lyfmail.com | trustlens |
| Signals | Privacy-first analytics. Human vs. bot detection without cookies or fingerprinting. | signals.lyfmail.com | signals |
| Ebb | Period tracker with homomorphic encryption. Your data stays encrypted — even from us. | ebb.lyfmail.com | ebb |
| LYF SOS | Offline emergency safety app for Android. Built for Indian families. | lyfsos.lyfmail.com | lyfsos |
| PDPR | Public Dark Pattern Registry. Document deceptive UX ethically. | pdpr.lyfmail.com | pdpr |
| Together | Mental health support through therapeutic silence and shared presence. | together.lyfmail.com | together |
| Rewriter | AI-powered narrative therapy and health content writing assistant. | lyfmail-official.github.io/rewriter | rewriter |
| Offload | Stress relief with binaural beats and dream journal. Zero cloud storage. | lyfmail-official.github.io/offload | offload |
- Health & Wellness Guide
- Personal Finance Guide
- Career Development Guide
- Creativity Resources
- Mindfulness Practices
Newsletter Signups: Health · Finance · Career · Creativity · Personal Development
This repository is licensed under the MIT License.
You are free to use, modify, and distribute this documentation — including commercially — with attribution. See LICENSE for full terms.
We welcome contributions from developers, technical writers, UX designers, SEO specialists, and digital wellness advocates.
- Fork this repository.
- Create a feature branch (
git checkout -b docs/your-topic). - Write clear, practical documentation with code examples where applicable.
- Submit a pull request with a detailed description of your changes.
- ✅ Use simple, clear Markdown formatting.
- ✅ Include code examples for all technical instructions.
- ✅ Follow the existing directory structure and naming conventions.
- ✅ Ensure all links are valid and point to live resources.
- ✅ Respect privacy-first principles in all documentation.
- ✅ Test all deployment instructions before submitting.
Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md before submitting.
- 🌐 Website: lyfmail.com
- 📚 Docs Hub: docs.lyfmail.com
- 📱 PWA: app.lyfmail.com
- 🎨 Brand Assets: github.com/lyfmail-official/lyfmail-brand-assets
- 🐦 X / Twitter: LYF Mail
- 📘 Facebook: LYF Mail
▶️ YouTube: LYF Mail- 💼 LinkedIn: LYF Mail
- 📧 Email: contact@lyfmail.com
- 🆘 Support: support.lyfmail.com
"Every Choice Shapes Tomorrow"
Maintained by LYF Mail · Founded by Ajay Kumar Chaudhary · Varanasi, Uttar Pradesh, India · Since 2020
Q: What is LYF Mail Docs?
A: LYF Mail Docs is the official documentation repository for the LYF Mail ecosystem — a comprehensive knowledge hub covering installation guides, PWA setup, technical references, developer tutorials, brand integration, and SEO best practices for LYF Mail and all its open-source tools.
Q: Is the documentation free to use?
A: Yes. All documentation in this repository is free and open-source under the MIT License. You can use, modify, and distribute it for personal or commercial purposes with attribution.
Q: Can I contribute to the documentation?
A: Yes. We welcome contributions from developers, technical writers, designers, and digital wellness advocates. Please read CONTRIBUTING.md for guidelines and submit pull requests via GitHub.
Q: What deployment platforms are covered?
A: Our deployment guides cover CyberPanel, OpenLiteSpeed, Cloudflare Pages, GitHub Pages, VPS with Nginx, and shared hosting (cPanel/DirectAdmin). More platforms are added based on community demand.
Q: Does LYF Mail Docs include API documentation?
A: API documentation is planned for future LYF Mail services. The repository structure includes placeholders for API references, and we will publish comprehensive API docs as endpoints become available.
Q: How is the documentation organized?
A: Documentation is organized into eight main sections: Getting Started, PWA Setup, Deployment, Technical References, Developer Tutorials, Brand Integration, SEO & Content Structure, and Troubleshooting. Each section contains focused Markdown files for easy navigation.
Q: Can I use LYF Mail brand assets in my own project?
A: Yes, with attribution. Our Brand Integration section includes detailed guidelines for logo usage, color palette, typography, and UI components. Please follow these guidelines to maintain brand consistency.
Q: Is there a quick start guide for beginners?
A: Yes. See getting-started/quick-start.md for a step-by-step guide to deploying your first LYF Mail PWA in under 10 minutes — no prior experience required.
Q: How does LYF Mail use subdomains for SEO?
A: LYF Mail uses a strategic subdomain architecture where each tool, newsletter category, and documentation area has its own subdomain (e.g., health.signup.lyfmail.com, signals.lyfmail.com, docs.lyfmail.com). This enables highly targeted SEO, clean content organization, and independent scaling. See seo-content-structure/subdomain-seo.md for detailed strategy.
Q: Where can I get help if I'm stuck?
A: Check the troubleshooting/ directory for common issues and solutions. For additional support, visit support.lyfmail.com or email contact@lyfmail.com.
This README is maintained by the LYF Mail team. For documentation improvements, technical questions, or contribution inquiries, please visit our GitHub repository.