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

45 lines
1.3 KiB
Markdown
Raw Normal View History

2018-09-17 05:46:06 +00: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 15:47:05 +00:00
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)
2021-09-05 15:07:51 +00:00
[![Download](https://img.shields.io/badge/download-v0.18.0-brightgreen.svg)](https://dl.vikunja.io)
[![Translation](https://hosted.weblate.org/widgets/vikunja/-/frontend/svg-badge.svg)](https://hosted.weblate.org/engage/vikunja/)
2018-09-17 05:46:06 +00:00
This is the web frontend for Vikunja, written in Vue.js.
2018-08-28 20:50:22 +00: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 13:05:57 +00: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 09:52:35 +00:00
## Docker
There is a [docker image available](https://hub.docker.com/r/vikunja/api) with support for http/2 and aggressive caching enabled.
2018-08-28 20:50:22 +00:00
## Project setup
```shell
2018-11-01 21:36:28 +00:00
yarn install
2018-08-28 20:50:22 +00:00
```
### Compiles and hot-reloads for development
```shell
2018-11-01 21:36:28 +00:00
yarn run serve
2018-08-28 20:50:22 +00:00
```
### Compiles and minifies for production
```shell
2018-11-01 21:36:28 +00:00
yarn run build
2018-08-28 20:50:22 +00:00
```
### Lints and fixes files
```shell
2018-11-01 21:36:28 +00:00
yarn run lint
2018-08-28 20:50:22 +00:00
```