Project Structure

This directory is the root directory of the Topola Genealogy Viewer project. It serves as the central hub containing project configuration, build setup, dependency management, and the main entry points for development, testing, and deployment. The actual application source code, assets, and tests are organized into subdirectories.

Purpose of this Directory

The root directory orchestrates the project. It contains configuration files for various tools (Vite, ESLint, Jest, Playwright, TypeScript), metadata about dependencies (package.json), and scripts for common tasks. It glues together the source code in src, the static assets in public, and the tests in tests.

Files in this Directory (Categorized by Role)

Here is an enumeration of the files in this directory, categorized by their role in the project:

Application Entry Point

index.html: The main HTML entry point for the application.

Build & Environment

.env: Contains environment variables for the project.
vite.config.mts: Configuration file for the Vite build tool.

Dependencies & Scripts

package.json: Defines the project's dependencies, scripts, version, and other metadata.
package-lock.json: Automatically generated file that describes the exact dependency tree that was generated by npm.
deploy-wikitree.sh: A shell script used to deploy the application files to WikiTree servers using lftp.

Tool Configuration

.eslintrc.js: Configuration file for ESLint, used for identifying and reporting on patterns in JavaScript/TypeScript code.
.gitignore: Specifies files and directories that should be ignored by Git.
prettier.config.mjs: Configuration for Prettier code formatter.
tsconfig.json: Configuration file for the TypeScript compiler.

Testing

playwright.config.ts: Configuration file for Playwright end-to-end testing framework.
jest.config.ts: Configuration file for the Jest testing framework used for unit tests.

Documentation & Assets

README.md: The main project documentation, covering features, examples, and usage instructions.
CHANGELOG.md: Records a log of notable changes made to the project over time.
docs/README.md: Registry for system design files describing containerization, AI protocol interfaces, Playwright integration, and screenshot testing.
LICENSE: The license file for the project (Apache License 2.0).
screenshot.png: An image showing a screenshot of the application, used in the README.md.

Subdirectories Overview

Based on the documentation in the subdirectories, here is a high-level overview of the project's structure:

docs: High-level technical and architectural design documents.
src: The core of the application.
- datasource: Handles loading and transforming genealogical data from various sources (files, URLs, WikiTree).
- menu: Contains navigation and menu components.
- sidepanel: Implements the side panel for details and configuration.
- translations: Holds localization JSON files.
- util: Common utilities for dates, analytics, and data processing.
public: Contains static assets (like the favicon) served directly at the root path.
tests: Contains end-to-end tests.

3.7 KiB Raw Permalink Blame History