Skip to content

Commit

Permalink
refine readme + adjust citation
Browse files Browse the repository at this point in the history
refs #202
  • Loading branch information
alee committed Oct 6, 2023
1 parent c27a9ed commit 485f268
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 9 deletions.
5 changes: 0 additions & 5 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ authors:
orcid: "https://orcid.org/0000-0001-9140-936X"
- family-names: "McPhillips"
given-names: "Timothy"
- family-names: "Nguyễn"
given-names: "Christine"
- family-names: "Pritchard"
given-names: "Calvin"
orcid: "https://orcid.org/0000-0002-4557-8602"
title: "Synthesizing Knowledge of Past Environments (SKOPE) Web Application"
doi: "10.5281/zenodo.6522974"
abstract: >
Expand Down
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,37 @@
[![DOI](https://zenodo.org/badge/159711888.svg)](https://zenodo.org/badge/latestdoi/159711888)
[![Build/Test Docker Image CI](https://github.com/openskope/skopeui/actions/workflows/docker-ci.yml/badge.svg)](https://github.com/openskope/skopeui/actions/workflows/docker-ci.yml)

This codebase provides a new user interface for the [NSF supported](https://www.openskope.org/skope-nsf-proposal) [Synthesizing Knowledge of Past Environments](https://www.openskope.org/) project.
This codebase provides a frontend only user interface for the [NSF supported](https://www.openskope.org/skope-nsf-proposal) [Synthesizing Knowledge of Past Environments](https://www.openskope.org/) project.

The UI was developed using [Nuxt](https://nuxtjs.org/), [VueJS](https://vuejs.org/), [Leaflet](https://leafletjs.com/), and [Plotly JS](https://plotly.com/javascript/).
The current UI uses [Nuxt 2](https://nuxtjs.org/), [VueJS](https://vuejs.org/), [Leaflet](https://leafletjs.com/), and [Plotly JS](https://plotly.com/javascript/).

The application has a simple [Makefile](https://www.gnu.org/software/make/) for configuration and deployment. In order to set up a development environment you'll need to have a recent version of Docker and docker-compose installed.
The application has a basic [Makefile](https://www.gnu.org/software/make/) for configuration and deployment. A recent version of [Docker](https://docs.docker.com/get-docker/) and [docker compose](https://docs.docker.com/compose/install/) is recommended to set up a local development environment.

Running `make` for the first time will generate a `config.mk` file that you can customize by setting the `DEPLOY_ENVIRONMENT` or the remote timeseries API and geoserver API urls. Running `make deploy` will then redeploy the application with those settings in place, listening by default on port 3000.
Running `make` for the first time will generate a default `config.mk` file that can be further customized:

- `DEPLOY_ENVIRONMENT` can be set to `dev`, `staging`, or `prod` (use `dev` for local development)
- `SKOPE_API_HOST_URL` should point at a SKOPE backend API to serve metadata and timeseries data (e.g., a deployed
instance of https://github.com/openskope/skope-api/)
- `SKOPE_GEOSERVER_HOST_URL` should point at a GeoServer instance with SKOPE datasets and geotiff layers preloaded
(see https://github.com/openskope/skope-datasets for more details)

Run `make deploy` to redeploy the application with whatever settings are currently defined in `config.mk`

With `DEPLOY_ENVIRONMENT=dev` a hot-reloading development server should spin up at http://localhost:3000


## Contributors

- Allen Lee @alee
- Kyle Bocinsky @bocinsky
- Calvin Pritchard @cpritcha
- Christine Nguyễn @chrstngyn

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

0 comments on commit 485f268

Please sign in to comment.