Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/readme #110

Merged
merged 5 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# syntax=docker/dockerfile:1
# check=skip=SecretsUsedInArgOrEnv
FROM node:22
ARG FONTAWESOME_PACKAGE_TOKEN
WORKDIR /app
Expand Down
58 changes: 12 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,27 @@
# lco-education-platform

## Project setup
```
npm install
```
This application is a part of the Photon Ranch Collection along with DataLab and the Education Platform.
Observe@PTR is where users, typically students, will go to request observations on the 40cm network and perform live observing.
![Screenshot of Dashboard](./Dashboard.png)

### Compiles and hot-reloads for development
```
npm run serve
```
## Project Setup Instructions

### Compiles and minifies for production
```
npm run build
```

### Lints and fixes files
```
npm run lint
```

## Running this project locally via Kubernetes

This project includes kubernetes manifests that allow it to be deployed to a kubernetes cluster.

To run this project in a local kind cluster:

Drop into the nix environment that contains all of the relevant tools.
## Getting Started Locally
### STEP 1: Install Nix
If you don't have Nix installed, you can follow [these steps](https://github.com/LCOGT/public-wiki/wiki/Install-Nix)
### STEP 2: Enter the Nix Dev Environment
```
nix develop --impure
```

Create a cluster and container registry.
```
ctlptl apply -f local-cluster.yaml -f local-registry.yaml
```

Make sure you update the skaffold.env.changeme and k8s/base/secrets.env.changeme to include the fontawesome package token

### STEP 3: Apply Configurations
```
mv skaffold.env.changeme skaffold.env
mv k8s/base/secrets.env.changeme k8s/base/secrets.env
ctlptl apply -f local-registry.yaml -f local-cluster.yaml
```

Then edit these and insert the token.
### STEP 4: Start the Skaffold Dev Loop

Finally, to build and deploy the service to the cluster we just created:
```
skaffold -m app dev --port-forward
```
After this step, you should be able to navigate to `http://127.0.0.1:8080` and run the application locally.

This starts the skaffold dev loop, which will rebuild the Docker image on code change, and will re-deploy the artifacts automatically.

The service will be available at http://localhost:8080


### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
=======
LCO's education platform for students and teachers
Loading
Loading