README.md

Open Science Framework Angular Project

This is the front-end angular repository for the Open Science Framework (OSF).

Quickstart (Docker)

docker compose up -d --build
# open http://localhost:4200

note Depending on local system architecture the build and launch of the angular server can take up to 60 seconds once the docker build finishes.

Index

First steps

• Install git commit template: Commit Template.
• Volta
• 3rd-party tokens Configuration

Recommended

• Docker Commands.
• Architecture.
• ESLint Strategy.
• Git Conventions.
• i18n.
• Models conventions.
• NGXS Conventions.
• SSR.
• SSR metrics.
• Testing Strategy.
• Sentry error filtering.

Optional

• Admin Knowledge Base: Admin Knowledge Base.

Testing the project

The project uses Vitest through Angular's unit test builder (ng test). A "counter" script displays local run stats after coverage runs.

npm run test               # single test run (no watch)
npm run test:one "src/path/to/file.spec.ts"  # run one spec file
npm run test:watch         # watch mode
npm run test:coverage      # coverage reports

Coverage thresholds are configured in vitest.config.ts (test.coverage.thresholds). To validate threshold updates after improving coverage:

npm run test:check-coverage-thresholds

Volta

OSF uses volta to manage node and npm versions inside of the repository Install Volta from volta and it will automatically pin Node/npm per the repo toolchain.

Configuration

OSF uses src/assets/config/config.json for third-party tokens and environment URLs. This file is not committed to the repo.

Copy src/assets/config/template.json to src/assets/config/config.json for local development. At runtime the app loads it from /assets/config/config.json.