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

Recommended

• Install git commit template: Commit Template.
• Docker Commands: Docker Commands.
• Git Conventions: Git Conventions.
• Volta: Volta

Optional

• Admin Knowledge Base: Admin Knowledge Base.

Testing the project

The project uses jest for unit testing. A "counter" script executes before and after each test run to track how many times the unit tests are run locally. The output is displayed.

npm run test (single test run)
npm run test:watch (single run after file save)
npm run test:coverage (code coverage results)

• all commits must pass the local pipeline for test coverage

npm run test:check-coverage-thresholds

• Verifies newly added tests match the thresholds
• This is only used until we hit 100% test coverage
• all commits must pass the local pipeline for test coverage

Volta

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