Open Digital Education Explorer

Explorer App

Getting Started

Install

Without Docker, you need to generate a package.json

node scripts/package.cjs

Install all dependencies.

pnpm install

Dev

pnpm dev

Server Options

You can configure Vite Proxy with backend routes needed for development inside vite.config.ts

const proxy = {
  "/example": proxyObj,
}

Absolute Imports

You should use absolute imports in your app

Replace ../components/* by ~/components/*

Configure your paths tsconfig.json:

Telling TypeScript how to resolve import path:

"paths": {
  "~/*": ["./src/*"],
  "~app/*": ["./src/app/*"]
}

Lint

Detect ESlint issues

pnpm lint

Prettier

Format code

pnpm format

Lighthouse

LHCI will check if your app respect at least 90% of these categories: performance, a11y, Best practices and seo

pnpm lighthouse

Pre-commit

When committing your work, pre-commit will start pnpm lint-staged:

lint-staged starts lint + prettier

pnpm pre-commit

Build

TypeScript check + Vite Build

pnpm build

Preview

pnpm preview

License

This project is licensed under the AGPL-3.0 license.