This repository has been archived on 2024-02-08. You can view files and clone it, but cannot push or open issues or pull requests.
frontend/README.md

53 lines
1.6 KiB
Markdown
Raw Normal View History

2018-09-17 07:46:06 +02:00
# Web frontend for Vikunja
> The todo app to organize your life.
[![Build Status](https://drone.kolaente.de/api/badges/vikunja/frontend/status.svg)](https://drone.kolaente.de/vikunja/frontend)
2020-12-23 16:47:05 +01:00
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)
2023-07-07 13:38:53 +02:00
[![Download](https://img.shields.io/badge/download-v0.21.0-brightgreen.svg)](https://dl.vikunja.io)
2021-09-06 21:22:18 +02:00
[![Translation](https://badges.crowdin.net/vikunja/localized.svg)](https://crowdin.com/project/vikunja)
2018-09-17 07:46:06 +02:00
This is the web frontend for Vikunja, written in Vue.js.
2018-08-28 22:50:22 +02:00
Take a look at [our roadmap](https://my.vikunja.cloud/share/UrdhKPqumxDXUbYpEGJLSIyNTwAnbBzVlwdDpRbv/auth) (hosted on Vikunja!) for a list of things we're currently working on!
2021-04-22 15:05:57 +02:00
## Security Reports
If you find any security-related issues you don't want to disclose publicly, please use [the contact information on our website](https://vikunja.io/contact/#security).
2019-08-17 11:52:35 +02:00
## Docker
There is a [docker image available](https://hub.docker.com/r/vikunja/api) with support for http/2 and aggressive caching enabled.
In order to build it from sources run the command below. (Docker >= v19.03)
```shell
export DOCKER_BUILDKIT=1
docker build -t vikunja/frontend .
```
Refer to Refer [to multi-platform documentation](https://docs.docker.com/build/building/multi-platform/) in order to build for the different platform.
2019-08-17 11:52:35 +02:00
2018-08-28 22:50:22 +02:00
## Project setup
```shell
2022-04-09 20:00:29 +02:00
pnpm install
2018-08-28 22:50:22 +02:00
```
### Compiles and hot-reloads for development
```shell
2022-04-09 20:00:29 +02:00
pnpm run serve
2018-08-28 22:50:22 +02:00
```
### Compiles and minifies for production
```shell
2022-04-09 20:00:29 +02:00
pnpm run build
2018-08-28 22:50:22 +02:00
```
### Lints and fixes files
```shell
2022-04-09 20:00:29 +02:00
pnpm run lint
2018-08-28 22:50:22 +02:00
```