Skip to content

Commit

Permalink
enhance README (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
nschnierer authored Feb 1, 2022
1 parent 5d22052 commit 10e4a3b
Showing 1 changed file with 20 additions and 22 deletions.
42 changes: 20 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,6 @@

This web application aims to implement the AOA method according to Meyer & Pebesma (2021) and provide the user an easy-to-use interface.

# Configuration

## Configuration

There are a few environment variables that can be set to configure the frontend dynamically.

| Variable | Default | Description |
| ----------------- | ---------------------- | ----------- |
| `VUE_APP_API_URL` | `http://localhost/api` | API URL. |

> For the Docker container you don't need to pass the `VUE_APP_` prefix.
> E.g.: `docker run -e API_URL=https://example.com ...`
## Installation

> Please make sure you are using NodeJS 16.x or above.
Expand All @@ -25,14 +12,18 @@ npm install

### Development

Using the local API:

> Please make sure you are started the API from the repository [digital-peaks/web-aoa](https://github.com/digital-peaks/web-aoa).
```
npm run serve
```

Using a different API URL:
Using the AWS API (no local API needed):

```
VUE_APP_API_URL=https://example.com npm run serve
VUE_APP_API_URL=https://web-aoa.schnierer.info:8780/api npm run serve
```

> For more details see the section [Configuration](#configuration).
Expand All @@ -53,17 +44,24 @@ npm run test:unit
npm run lint
```

### Customize configuration
## Configuration

There are a few environment variables that can be set to configure the frontend dynamically.

See [Configuration Reference](https://cli.vuejs.org/config/).
| Variable | Default | Description |
| ----------------- | ---------------------- | ----------- |
| `VUE_APP_API_URL` | `http://localhost/api` | API URL. |

> For the Docker container you don't need to pass the `VUE_APP_` prefix.
> E.g.: `docker run -e API_URL=https://example.com ...`
# Used technologies

* [Vue.js](https://github.com/vuejs/vue)
* [Vuetify](https://github.com/vuetifyjs/vuetify)
* [Leaflet](https://github.com/Leaflet/Leaflet)
* [georaster-layer-for-leaflet](https://github.com/GeoTIFF/georaster-layer-for-leaflet)
- [Vue.js](https://github.com/vuejs/vue)
- [Vuetify](https://github.com/vuetifyjs/vuetify)
- [Leaflet](https://github.com/Leaflet/Leaflet)
- [georaster-layer-for-leaflet](https://github.com/GeoTIFF/georaster-layer-for-leaflet)

# License
# License

[MIT](https://github.com/digital-peaks/web-aoa-frontend/blob/main/LICENSE)

1 comment on commit 10e4a3b

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for digital-peaks-web-aoa-frontend ready!

✅ Preview
https://digital-peaks-web-aoa-frontend-hwyvxj53b-nschnierer.vercel.app

Built with commit 10e4a3b.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.