-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Details about app and both method of running the app
- Loading branch information
Showing
1 changed file
with
22 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,32 @@ | ||
# datalab | ||
# Datalab-UI | ||
|
||
## Project setup | ||
``` | ||
npm install | ||
``` | ||
Frontend for the Datalab project. Connected to a [Backend Django Application](https://github.com/LCOGT/ptr_datalab) as well as the Science Archive. | ||
### Important Technologies | ||
- VueJs: Web Framework | ||
- Vuetify: Component Library | ||
- Leaflet Maps: Mapping Library | ||
- Pinia: Global Store | ||
|
||
## Development | ||
|
||
There are two ways to run this project; running the app on your machine directly with NPM V.S the more complete local kube cluster method. | ||
|
||
### Compiles and hot-reloads for development | ||
If you need fast feedback and iterative development the minimal dev will be simplier, | ||
but you should also test it and make sure it works using the full kubernetes cluster method before opening a PR. | ||
|
||
### 1. Local Machine | ||
``` | ||
npm install | ||
npm run serve | ||
``` | ||
|
||
### Compiles and minifies for production | ||
### 2. Full K8s Enviorment | ||
Enter the nix enviorment and ensure local cluster and registry are running | ||
``` | ||
npm run build | ||
nix develop --impure | ||
ctlptl apply -f local-registry.yaml -f local-cluster.yaml | ||
``` | ||
|
||
### Lints and fixes files | ||
Start the cluster and app | ||
``` | ||
npm run lint | ||
skaffold -m app dev --port-forward | ||
``` | ||
|
||
### Customize configuration | ||
See [Configuration Reference](https://cli.vuejs.org/config/). |