Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 3.03 KB

README.md

File metadata and controls

107 lines (68 loc) · 3.03 KB
Raw

aw-supabase

Build

A work-in-progress MVP for ActivityWatch subscriptions, leaderboards, and more.

Uses Vue + Vite + Tailwind + Supabase.

Uses Vitest for unittests, and playwright for e2e tests.

Development

# Install dependencies
npm install

# Start supabase locally in a docker container
npx supabase start

# Run the app
npm start

Previous attempts

I made a previous attempt at creating a leaderboard with Firebase here.

I also wrote a leaderboard server in Rust here.

The following is the default Vite/Vue README.md

Vite + Vue 3 + TypeScript + Volar Starter

This template should help get you started developing with Vue 3 in Vite.

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