upda/server/web/README.md

44 lines
1 KiB
Markdown
Raw Normal View History

2024-11-29 21:55:15 +00:00
# README
2024-11-29 21:55:15 +00:00
Frontend for _upda_.
2024-11-29 21:55:15 +00:00
## Configuration
2024-11-29 21:55:15 +00:00
* During development: `.env.development`
* Production derives the values from their main GoLang application, some environment variables are coupled with their
backend one, some are exposed via `WEB_*`, but internally mapped to `VITE_` in the `app.go` file
## Development & contribution
Contributions are very welcome!
### Prerequisites
It's probably worth checking out a node environment manager like [nvm manager](https://github.com/nvm-sh/nvm).
Required node and npm versions are outlined in the `package.json`.
### Setup instructions
Run `npm install` which should install all dependencies.
### Start
Use the `npm run start` command to start the development setup. Backend should be running.
2024-11-29 21:55:15 +00:00
### Translation files
2024-11-29 21:55:15 +00:00
Pipeline checks for existing i18n keys, if you need to manually sync any language file, run `npm run i18n-sync`.
2024-11-29 21:55:15 +00:00
### Dependencies
2024-11-29 21:55:15 +00:00
To track unused dependencies
2024-11-29 21:55:15 +00:00
```shell
# install (if not yet present)
npm install -g depcheck typescript
2024-11-29 21:55:15 +00:00
# run
depcheck
```