Skip to content

Latest commit

 

History

History
131 lines (74 loc) · 4.11 KB

README.md

File metadata and controls

131 lines (74 loc) · 4.11 KB

A thousand channels: Map client

A prototype of a map frontend for the A thousand channels project w/Nuxt.js v2

Preview: https://a-thousand-channels.github.io/a1000c-map-client/

It renders map data provided via ORTE Backend. Currently some sample map data is shown.

You can manually load any layer (that has the status "Published") into the client. Just add the URL of the layer to the URL with the param layer.

https://a-thousand-channels.github.io/a1000c-map-client/?layer=LAYER_JSON_URL

(You have to replace the placeholder LAYER_JSON_URL with a real URL.)


Testing

e2e and component testing with Cypress

e2e testing

# start the client
$ yarn dev
# run cypres
$ yarn run cypress open

Tests are located in /cypress/integration

Component testing

With Cypress + Webpacker

# run with yarn
$ yarn run cypress open-ct
# run with npx
$ npx cypress open-ct

Tests reside in-place in the /components-folder

More infos about Cypress component testing

Installation explained in Cypress.io Framework Configuration


Nuxt.js Installation and setup

Installation

# install dependencies
$ yarn install

Build/Run

# serve with hot reload at localhost:3000
$ yarn dev

# serve at <YOUR_IP>:3000, to make it accessible for other machines in your network
$ HOST=<YOUR_IP> npm run dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

For detailed explanation on how things work, check out the documentation.

Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

assets

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in the documentation.

components

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in the documentation.

layouts

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in the documentation.

pages

This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in the documentation.

plugins

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.

More information about the usage of this directory in the documentation.

static

This directory contains your static files. Each file inside this directory is mapped to /.

Example: /static/robots.txt is mapped as /robots.txt.

More information about the usage of this directory in the documentation.

store

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in the documentation.