Openedu Platform

This is an official openedu repo for the Frontend team.

Recommended system

• Nodejs: >= 20 https://nodejs.org/en/download/package-manager
  • Recommend: use Fast node manager
• Pnpm: latest version https://pnpm.io/installation
  • update latest version: npm install -g pnpm.
• Editor: vscode, cursor.
• Change localhost to localhost from /etc/hosts file

// window: C:\Windows\System32\drivers\etc\hosts
// mac & Linux: /etc/hosts
127.0.0.1 localhost
127.0.0.1 vbi.localhost
127.0.0.1 not-org.localhost

Open http://localhost:3000 with your browser to see the result.

Structure - monorepo

|- openedu
  |- apps
    |- admin
    |- learner
    |- blog
    |- affiliate
    |- platform
  |- packages
    |- api
    |- config
    |- builder
    |- assets
    |- core
    |- i18n
    |- config
    |- types
    |- ui
    ...
  package.json
  .env.development # variables for development environment
  .env.staging # variables for staging environment
  .env.production # variables for production environment
  ...

Scripts

Workspace is always root repo.

• Installation

pnpm install

• Add packages

pnpm add {npm_package} --filter {sysadmin,platform}

• Run dev

pnpm dev
pnpm dev --filter {sysadmin,platform}

• Run build

pnpm build
pnpm build --filter {sysadmin,platform}

• Run type check for typescript

pnpm typecheck
pnpm typecheck --filter {sysadmin,platform}

• Run lint

pnpm lint
pnpm lint:fix

• Run scripts for shadcn UI components for @oe/ui package

pnpm ui:add
pnpm ui:diff

• Run clean for remove node_modules, dist, .next.

pnpm clean

• Run analyzer

pnpm analyzer
pnpm analyzer --filter {sysadmin,platform}