An open API service indexing awesome lists of open source software.

https://github.com/exhuma/powonline-frontend

This repository contains the frontend code for "powonline"
https://github.com/exhuma/powonline-frontend

Last synced: 4 months ago
JSON representation

This repository contains the frontend code for "powonline"

Awesome Lists containing this project

README

          

# powonline

Powonline is an application to track team-progress from a local game-event.

# Maintenance

The project targets a docker-container for deployment. The appropriate
`Dockerfile` is included in the project root. During the build process, a few
environment variables are used and baked into the code. The reference for these
variables (with sample data) is located in the `.env` file. See the "vite"
documentation for more information on how env-files are loaded.

The project contains a GitHub workflow to automate the build and publish
process. For this process, the requirement environment variables can be set
using GitHub secrets.

## Recommended IDE Setup

[VSCode](https://code.visualstudio.com/) +
[Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and
disable Vetur) + [TypeScript Vue Plugin
(Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## 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)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)
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](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669)
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](https://vitejs.dev/config/).

## Project Setup

```sh
npm install
```

### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Type-Check, Compile and Minify for Production

```sh
npm run build
```

### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint
```