A Vue.js client for Geyser
This project uses pnpm
as the package manager. If you haven't installed pnpm
, you can do so by running the install
script (for POSIX systems):
curl -fsSL https://get.pnpm.io/install.sh | sh -
After installing pnpm
, you can install the project dependencies by running
pnpm i
The following pnpm scripts are available:
- Launch the development server with hot module replacement (HMR)
pnpm run dev
- Create an optimized production build
pnpm run build
- Serve the production build locally for testing
pnpm run preview
- Execute the test suite once
pnpm run test
- Run tests in watch mode for development
pnpm run test:watch
- Auto-fix code formatting using Prettier
pnpm run format
- Check code formatting without making changes
pnpm run format:check
- Check code for quality issues using ESLint
pnpm run lint
- Auto-fix ESLint issues where possible
pnpm run lint:fix
- Verify TypeScript types across all source files
pnpm run typecheck
- Run all quality checks (types, formatting, linting, and tests)
pnpm run validate
- Generate code from GraphQL schema and operations
pnpm run codegen
Environment variables can be stored in either of the following .env files:
.env.local
.env.development
and.env.development.local
(development mode).env.production
and.env.production.local
(production mode)
The following environment variables are used by the client.
Environment variable | Description |
---|---|
VITE_BUILD_VERSION |
Build version (shown in top-left corner) |
VITE_GRAPHQL_URL |
GraphQL engine URL |
VITE_AUTH_URL |
Keycloak authentication server URL |
VITE_BYPASS_AUTH |
Bypass Keycloak auth in development (if set to true ) |
VITE_HASURA_ADMIN_SECRET |
Hasura admin secret (when bypassing Keycloak) |
VITE_HASURA_USER_ID |
Hasura user ID (when bypassing Keycloak) |
For questions, suggestions, or bug reports, contact Julien Hauseux <[email protected]>.
Licensed under GNU AGPL v3.0 – see LICENSE.