PathAtlas is a file indexing and inventory platform that scans project directories, records file metadata, and stores content hashes for efficient tracking, analysis, and change detection.
- Recursive file discovery and indexing
- Content hashing for file integrity verification
- Persistent path storage using MongoDB
- Project-based organization
- Designed for large codebases and file collections
Before getting started, ensure the following software is installed:
- Node.js (v18 or newer recommended)
- Yarn
- MongoDB
Clone the repository and install dependencies:
git clone https://github.com/LSUHSC-CAIPP-Core-B/PathAtlas.git
cd PathAtlas
yarn installStart the development environment:
yarn devRun a full build test:
yarn buildTestPathAtlas is configured through environment variables.
| Variable | Description | Default |
|---|---|---|
DATABASE_PROTOCOL |
MongoDB connection protocol | mongodb |
DATABASE_URL |
MongoDB hostname or IP address | — |
DATABASE_USER |
Database username | — |
DATABASE_PASS |
Database password | — |
DATABASE_NAME |
Database name | — |
TARGET_DIRECTORY |
Root directory to scan and index | . |
INDEX_FILES |
Filename used to store generated indexes | indexes.json |
LIMIT_FILES_TO_LOG |
Maximum number of discovered files written to the console | 10 |
DATABASE_PROTOCOL=mongodb
DATABASE_URL=localhost:27017
DATABASE_NAME=pathatlas
DATABASE_USER=management
DATABASE_PASS=<password>
TARGET_DIRECTORY=.
INDEX_FILES=indexes.json
LIMIT_FILES_TO_LOG=10PathAtlas scans a target directory and generates an inventory of discovered files. Each file is analyzed and assigned a content hash, allowing the system to:
- Detect file modifications
- Track project contents over time
- Identify duplicate files
- Verify file integrity
- Build searchable project indexes
Indexed data is persisted to MongoDB for efficient retrieval and analysis.
Licensed under the GPL-3.0 License.
© 2025 LSUHS