https://github.com/datagouv/explore.data.gouv.fr

A simple frontend for https://github.com/etalab/csvapi
https://github.com/datagouv/explore.data.gouv.fr

Last synced: 3 months ago
JSON representation

A simple frontend for https://github.com/etalab/csvapi

• Host: GitHub
• URL: https://github.com/datagouv/explore.data.gouv.fr
• Owner: datagouv
• License: mit
• Created: 2018-04-26T16:14:13.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-16T14:45:36.000Z (5 months ago)
• Last Synced: 2024-07-16T18:13:56.547Z (5 months ago)
• Language: Vue
• Homepage: https://explore.etalab.studio
• Size: 8.75 MB
• Stars: 25
• Watchers: 7
• Forks: 8
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Explore.data.gouv.fr

Explore.data.gouv.fr is a UI for [csvapi](https://github.com/opendatateam/csvapi).

## Install

```shell

npm install --save @etalab/explore.data.gouv.fr

```

## Configuring

In order to work with [csvapi](https://github.com/opendatateam/csvapi), CSVAPI front should know its URL.

You can either provide a default one at build time (see [Envrionment variables](#environment-variables)) or provide one at runtime.

To provide a runtime configuration, just define a `` in your html with the `content` attribute containing the CSVAPI URL.

**ex:**

```html

```

## Parameters

This UI expect a `url` query string to be able to load a tabular file.

## Development

### Getting started

This app has been tested under Node v10.

Install all dependencies and laucnh the development server

```shell

npm install

npm run serve

```

You can build a final version using:

```shell

npm run build

```

### Environment variables

You can provide some build time configuration using a `.env` file (see the `.env.sample`).

Known environment variables are:

- `VUE_APP_CSVAPI_URL`: csvapi instance URL

- `VUE_APP_FILTERS_ENABLED`: boolean, enables or disables filter support

If you want to enable matomo tracking, you should specify the target site id:

- `VUE_APP_MATOMO_SITE_ID`