mirror of
https://github.com/go-vikunja/vikunja.git
synced 2026-04-29 08:27:02 +00:00
25ff8939f6
In dev environment, this PR allows to proxy to whatever backend without CORS issue by specifying the backend URL in `.env.local` variable. I believe this would ease contribution by frontend developpers that would only have to run the unstable docker to work on the frontend without need for all the go toolchain to build the whole backend to have a cors enabled backend. Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/vikunja/pulls/3069 Co-authored-by: Marc <marc88@free.fr> Co-committed-by: Marc <marc88@free.fr>
52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
# Web frontend for Vikunja
|
|
|
|
> The todo app to organize your life.
|
|
|
|
[](LICENSE)
|
|
[](https://crowdin.com/project/vikunja)
|
|
|
|
This is the web frontend for Vikunja, written in Vue.js.
|
|
|
|
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!
|
|
|
|
For general information about the project, refer to the top-level readme of this repo.
|
|
|
|
## Project setup
|
|
|
|
```shell
|
|
pnpm install
|
|
```
|
|
|
|
### Development
|
|
|
|
#### Define backend server
|
|
|
|
You can develop the web front end against any accessible backend, including the demo at https://try.vikunja.io
|
|
|
|
In order to do so, you need to set the `DEV_PROXY` env variable. The recommended way to do so is to:
|
|
|
|
- Copy `.env.local.exemple` as `.env.local`
|
|
- Uncomment the `DEV_PROXY` line
|
|
- Set the backend url you want to use
|
|
|
|
In the end, it should look like `DEV_PROXY=https://try.vikunja.io` if you work against the online demo backend.
|
|
|
|
|
|
#### Start dev server (compiles and hot-reloads)
|
|
|
|
```shell
|
|
pnpm run dev
|
|
```
|
|
|
|
### Compiles and minifies for production
|
|
|
|
```shell
|
|
pnpm run build
|
|
```
|
|
|
|
### Lints and fixes files
|
|
|
|
```shell
|
|
pnpm run lint
|
|
```
|