Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Details about app and both method of running the app
  • Loading branch information
LTDakin authored Dec 23, 2024
1 parent a3ce041 commit 3def022
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.md
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/).

0 comments on commit 3def022

Please sign in to comment.