IMDirectory

Project setup

The proxy expects the IMAPI to be running on localhost:8080

node, npm, pnpm

IMDirectory uses node, npm and pnpm. Current recommended compatable versions are:

Package	Version
node	18.17.0
npm	9.6.7
pnpm	9.11.0

Fontawesome

IMDirectory uses FontAwesome Pro. The project is setup to connect to a self-hosted version of fontawesome pro. This setup is contained in the root file

index.html

Install

pnpm install

Environment variables

In project root add file

.env

File should contain:

CYPRESS_LOGIN_USERNAME="username for IMDirectory account cypress will use"
CYPRESS_LOGIN_PASSWORD="password for IMDirectory account cypress will use"
VITE_HOSTING_MODE="public" || "private"

Compiles and hot-reloads for development

pnpm dev

Compiles and minifies for production

pnpm build

Preview production build

npm preview

Lints and fixes files

Lint using esLint

pnpm lint

Format using prettier

pnpm lint

Testing

Unit test using vitest

pnpm test:unit

E2E test using cypress

pnpm test:e2e

Customize configuration

For customisation the config is in the root folder file

vite.config.ts

See Configuration Reference.