LEG supports GEDCOM 5.5.5 (industry standard) and 7.0 (latest), with partial compliance: sources/notes import/export planned for a future release. See compliance report for details.

LEG: Lineage Exploration & Genealogy Platform

A modern, open-source genealogy platform that makes family history accessible to everyone.

Platform Overview

```mermaid graph TB subgraph "User Interface" UI[Web Interface] M[Mobile Responsive] V[Interactive Visualizations] end

subgraph "Core Features"
    T[Family Trees]
    S[Search & Discovery]
    C[Collaboration]
    M2[Media Management]
end

subgraph "Data Management"
    G[GEDCOM Import/Export]
    P[Privacy Controls]
    V2[Data Validation]
    B[Backup & Sync]
end

subgraph "Technology Stack"
    L[Laravel Backend]
    N[Neo4j Graph DB]
    PG[PostgreSQL]
    D3[D3.js Visualizations]
end

UI --> T
UI --> S
UI --> C
UI --> M2
T --> G
S --> P
C --> V2
M2 --> B
G --> L
L --> N
L --> PG
V --> D3

```

✨ What Makes LEG Special

• Interactive Family Trees: Beautiful D3.js visualizations that bring your family history to life
• Collaborative Research: Work together with family members and researchers
• Modern Technology: Built with Laravel, Neo4j, and cutting-edge web technologies
• Privacy First: Granular controls to protect sensitive family information

Feature Architecture

```mermaid flowchart LR subgraph "Core Features" A[Tree Management] B[Individual Profiles] C[Relationship Mapping] D[Event Timeline] end

subgraph "Advanced Features"
    E[GEDCOM Processing]
    F[Media Library]
    G[Source Citation]
    H[Collaboration Tools]
end

subgraph "User Experience"
    I[Search & Filter]
    J[Privacy Controls]
    K[Export Options]
    L[Mobile Access]
end

A --> E
B --> F
C --> G
D --> H
E --> I
F --> J
G --> K
H --> L

```

🚀 Quick Start

```bash

Clone the repository

git clone https://github.com/pratikid/LEG.git cd LEG

Start the application

./setup.sh # For Linux/Mac

or

setup.bat # For Windows ```

📚 Documentation

Getting Started

• Installation Guide
• User Guide

Developer Documentation

• Developer Guide
• API Reference
• Best Practices
• Clean Code Guidelines
• Commit Guidelines
• Security Guidelines
• GEDCOM Compliance
• Tree View Implementation
• UI/UX Guidelines
• Tools Integration
• Technical Dictionary
• Navigation System

Project Planning

• Enhancement Plan
• Repository Organization
• Lumen to Laravel Migration Plan

Additional Resources

• Best Practices
• Clean Code Guidelines
• Commit Guidelines
• Repository Organization

🤝 Contributing

We welcome contributions! See our Contributing Guide for details.

🛠️ Technology Stack

• Backend: Laravel 10+, PHP 8+
• Frontend: Vue.js 3, Tailwind CSS
• Database: PostgreSQL, Neo4j, Redis
• Search: Elasticsearch/Algolia
• File Storage: AWS S3/MinIO
• Monitoring: Sentry, New Relic

📋 Features

• Interactive family tree visualization
• GEDCOM 5.5.5 and 7.0 import/export support
• Advanced search and filtering
• Collaborative research tools
• Privacy controls and sharing options
• Timeline views and relationship mapping
• Media library and document management
• Source citation and validation

🔒 Security

• Granular privacy controls
• Role-based access control
• Secure data storage
• Regular security audits

📈 Roadmap

See our Enhancement Plan for upcoming features and improvements.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Thanks to all contributors who have helped shape LEG
• Special thanks to the Laravel and Neo4j communities
• Inspired by the need for modern genealogy tools

LEG - Lineage Exploration and Genealogy

LEG is a project dedicated to Lineage Exploration and Genealogy. It aims to provide resources, tools, and information for individuals interested in discovering, documenting, and understanding their family history. Whether you're a seasoned genealogist or just starting your ancestral journey, LEG offers a community and a collection of valuable materials to aid your exploration.

Table of Contents

• Introduction
• Project Goals
• Documentation
• Getting Started
  • Contributing
  • Code of Conduct
• Resources
  • Tools & Software
  • Educational Materials
  • Community Forum
  • Data Sources & Archives
• Roadmap
• Support
• License
• Acknowledgements

Introduction

The desire to understand our roots is a fundamental human instinct. LEG (Lineage Exploration and Genealogy) is born from this desire, aiming to make the process of discovering and documenting family history more accessible, engaging, and collaborative. This project serves as a central hub for anyone interested in genealogy, offering a curated collection of resources, fostering a supportive community, and potentially developing open-source tools to aid in genealogical research.

We believe that everyone has a story to tell, and understanding our family's past enriches our present and shapes our future. LEG is here to help you uncover those stories.

Project Goals

The primary goals of the LEG project are:

• Centralize Resources: To create a comprehensive collection of links, guides, and information relevant to genealogical research.
• Foster Community: To build a supportive and collaborative environment for genealogists of all skill levels to connect, share knowledge, and assist each other.
• Promote Best Practices: To advocate for accurate research methodologies, ethical data handling, and proper citation of sources in genealogical work.
• Explore Technological Solutions: To investigate and potentially develop open-source tools and utilities that can streamline and enhance the genealogical research process (this is a future aspiration).
• Democratize Genealogy: To make genealogical research more accessible to individuals regardless of their background or resources.

Documentation

• Features
• User Guide
• Setup Guide
• UI/UX Guide

Technology Integration

• Livewire:
  • Dynamic form updates
  • Real-time data synchronization
  • Responsive UI components
• D3.js:
  • Family tree visualizations
  • Timeline displays
  • Relationship diagrams
  • Geographic visualizations
• Neo4j:
  • Efficient relationship management
  • Complex query handling
  • Graph-based data structure

Getting Started

This repository serves as the central point for the LEG project. Here's how you can get involved:

• Explore the Resources: Browse the various sections of this README and the linked resources to start your genealogical journey or enhance your existing research.
• Contribute: If you have valuable resources, links, or suggestions, please consider contributing to this repository. See the Contributing section for more details.
• Engage with the Community (Future): Once the community forum is established, participate in discussions, ask questions, and share your knowledge.
• Stay Updated: Watch this repository for updates on new resources, community initiatives, and potential tool development.

Contributing

We welcome contributions from the community! If you have valuable resources, links, educational materials, or ideas that align with the project goals, please follow these steps:

1. Fork the repository.
2. Create a new branch for your contribution (git checkout -b feature/your-contribution).
3. Make your changes. Ensure your contributions are well-organized and clearly documented.
4. Submit a pull request. Provide a clear and concise description of your changes and their purpose.

We appreciate your efforts in making LEG a valuable resource for the genealogical community.

Code of Conduct

We are committed to fostering a welcoming and inclusive environment for all contributors and users. By participating in the LEG project, you agree to abide by our Code of Conduct (link to be created). Please ensure you read and understand these guidelines.

Local Development Setup

1. Clone the repository: sh git clone https://github.com/pratikid/LEG.git cd LEG
2. Copy the example environment file and configure your environment: sh cp .env.example .env # Edit .env as needed
3. Install PHP dependencies: sh composer install
4. Install Node dependencies: sh npm install
5. Build frontend assets: sh npm run dev
6. Run database migrations and seeders: sh php artisan migrate --seed
7. Start the local server: sh php artisan serve

Running Tests

Run all tests using PHPUnit: sh php artisan test

Code Style

This project uses Laravel Pint for code style (PSR-12): sh composer run lint

Resources

This section provides a categorized list of resources to aid your lineage exploration and genealogy research.

Tools & Software

• Online Family Tree Builders:
  • Ancestry.com (Subscription-based)
  • MyHeritage (Subscription-based)
  • FamilySearch (Free)
  • Geni.com (Freemium)
• Genealogy Software (Desktop):
  • Gramps (Free & Open Source)
  • Legacy Family Tree (Freemium)
  • RootsMagic (Paid)
• Mobile Apps:
  • (List popular genealogy apps for iOS and Android)
• DNA Testing Services:
  • AncestryDNA
  • 23andMe
  • MyHeritage DNA
• Record Management Tools:
  • (Suggest tools for organizing digital and physical records)

Educational Materials

• Online Courses & Tutorials:
  • National Genealogical Society (NGS)
  • Association of Professional Genealogists (APG)
  • FamilySearch Learning Center
  • Coursera (Search for genealogy courses)
  • edX (Search for genealogy courses)
• Genealogy Blogs & Websites:
  • (List reputable genealogy blogs and informational websites)
• Books & Guides:
  • (Suggest foundational books on genealogical research)
• Podcasts & YouTube Channels:
  • (List relevant audio and video resources)

Community Forum (Future)

• (Once established, provide a link and description of the forum)
  • Ask Questions: Get help with your research challenges.
  • Share Discoveries: Announce exciting finds and breakthroughs.
  • Connect with Others: Network with fellow genealogists based on location, surname, or research interests.
  • Discuss Methodologies: Share tips and best practices for effective research.

Data Sources & Archives

• Census Records:
  • National Archives and Records Administration (NARA) (US)
  • The National Archives (UK)
  • (List links to census records for other major countries)
• Vital Records (Birth, Marriage, Death):
  • (Provide general guidance and links to resources for finding vital records)
• Immigration Records:
  • Ellis Island Archives
  • (List links to immigration records for various countries)
• Military Records:
  • (Provide links to military archives for different regions)
• Probate Records:
  • (Offer guidance on accessing probate records)
• Land Records:
  • (Provide general information on finding land records)
• Historical Societies & Libraries:
  • (Suggest resources for finding local historical societies and genealogical libraries)
• Online Genealogical Databases:
  • (List major subscription and free genealogical databases)

Roadmap

The LEG project is continuously evolving. Here are some planned future developments:

• Establish a Community Forum: Creating a dedicated space for user interaction and support.
• Develop Basic Genealogical Tools: Exploring the feasibility of open-source tools for tasks like source citation management or simple family tree visualization.
• Curate Regional Resources: Expanding the list of data sources and archives with a focus on specific geographic regions.
• Translate Resources: Making key materials accessible in multiple languages.
• Develop Learning Modules: Creating structured educational content on specific genealogical topics.

Support

If you have any questions, suggestions, or encounter any issues, please:

• Open an issue in this GitHub repository.
• (Once established) Engage in the community forum.

We appreciate your feedback and contributions!

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Acknowledgements

We would like to thank the following individuals and organizations for their contributions and support (this section will grow as the project evolves):

• (Acknowledge initial contributors and inspirations)
• The open-source community for providing valuable tools and resources.
• Genealogical societies and archives for their dedication to preserving history.

Thank you for being a part of the LEG project! Let's explore our roots together.