/dsb-fe

Dashboard for viewing a set of data

Primary LanguageTypeScript

dsb-fe

This is a small web application that provides a dashboard showing how many data sets as per some specific API response. The minitry with highest data-set is highlighted by default whenever being displayed.

Tech-stack

  • Vue 3
  • Typescript
  • TailwindCSS (with postcss)
  • Vite (build tool)
  • Vitest (unit test)
  • Playwright (e2e tests)
  • Yarn. Though you can use your preferred package manager.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Playwright

# Install browsers for the first run
npx playwright install

# When testing on CI, must build the project first
npm run build

# Runs the end-to-end tests
npm run test:e2e
# Runs the tests only on Chromium
npm run test:e2e -- --project=chromium
# Runs the tests of a specific file
npm run test:e2e -- tests/example.spec.ts
# Runs the tests in debug mode
npm run test:e2e -- --debug

Lint with ESLint

npm run lint

Using Docker

The project comes with a dockerfile for executing the application seamlessly on your machine. Assuming you already have Docker installed:

Build the dockerfile

docker build -t '<your-image-name>' .

Run the image in a container

docker run -it -p 5173:5173 --rm --name container-name image-name