Technical Documentation

This section contains the technical documentation for Atlas intended for developers.

Are you a researcher? Check out instead:

• Atlas Home - General overview
• Atlas Verify Guide - User documentation for researchers

Overview

Atlas is a TypeScript monorepo using Effect for functional programming and error handling.

Project Structure

atlas/
├── apps/
│   └── ecrin/              # SvelteKit Dashboard (Zero Trust)
├── packages/
│   ├── crf/                # REDCap client, server, CLI
│   ├── net/                # Network utilities
│   └── typescript-config/  # Shared TypeScript config
├── infra/                  # Kubernetes infrastructure
└── docs/                   # Documentation (this site)

Tech Stack

Area	Technologies
Runtime	Node.js 20+, TypeScript 5.x
Framework	Effect (functional programming)
Frontend	SvelteKit 2, Svelte 5 (runes)
Package manager	pnpm (workspaces)
Build	Vite, tsup
Test	Vitest
Lint	ESLint, Prettier
Kubernetes	k3d (dev), k3s (prod), Cilium, SPIRE, OPA

Documentation by Domain

Atlas CRF (REDCap)

Document	Description
Client and server	REDCap integration with Effect
CLI Tools	Command line tools

Atlas Citations

Document	Description
Overview	Package architecture
Bibliographic sources	Clients by source
Atlas Verify	Verification system

Infrastructure

Document	Description
General architecture	Effect patterns, ESLint, scripts
Zero Trust infrastructure	Kubernetes, security
Workspace conventions	Repository structure and naming rules

Audits

Document	Description
Dependencies audit	Inventory and update roadmap

Quick Start

Installation

# Clone the repo
git clone https://github.com/univ-lehavre/atlas.git
cd atlas

# Install dependencies
pnpm install

# Start development
pnpm dev

Main Commands

pnpm dev          # Development with hot-reload
pnpm build        # Build all packages
pnpm test         # Unit tests
pnpm lint         # Code verification
pnpm ready        # Complete pre-commit checks

REDCap Configuration

# Environment variables
export REDCAP_API_URL=https://redcap.example.com/api/
export REDCAP_API_TOKEN=YOUR_32_CHAR_HEXADECIMAL_TOKEN

# Test the connection
pnpm -F @univ-lehavre/crf crf-redcap test

État des packages 7

Package	Version	Releases	PRs	Commits	Fichiers	Lignes	Types	Fonctions	TSDoc	Tests	Dernier commit
appwrite	0.2.2	2	3	16	3	757	5	3	16	11	Il y a 1 semaine
auth	0.2.2	2	3	16	5	1291	6	9	30	39	Il y a 1 semaine
errors	0.2.2	2	3	13	5	804	2	1	18	16	Il y a 1 semaine
logos	1.1.1	1	2	7	0	580	0	0	0	0	Il y a 2 semaines
net	1.0.1	5	8	41	6	6204	11	6	53	67	Il y a 1 semaine
redcap-core	1.1.2	2	3	19	43	6955	54	85	308	662	Il y a 1 semaine
validators	0.2.2	2	3	13	3	787	0	6	8	49	Il y a 1 semaine

Premier commit : 19 janvier 2026 · Dernier commit : 10 avril 2026

Statistiques générées le 10 avril 2026 à 08:40

Contributing

1. Create a branch from main
2. Make your changes
3. Run pnpm ready to verify
4. Create a Pull Request

See CONTRIBUTING.md for more details.