ingalls / wh2o-vue

Home Page:https://wh2o-vue.herokuapp.com/#/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

wh2o-vue

Build Status Coverage Status

This app is the American Whitewater National Whitewater Index and River Detail SPA.

Prototype

https://wh2o-vue.herokuapp.com/#/

Getting Started

This project requires the main American Whitewater API. Follow instructions in the dockerreadme.md located in the wh2o repo for development setup guidelines.

Clone the wh2o repo, build docker containers, and bring them up. The main API, which serves river info, flow data, and more, runs at http://localhost:8080/. Be sure to update the env variables accordingly.

Since this app only requires the main wh2o API, we do not need the Asset Builder container running. It is resource-intensive and can significantly impact your machine's performance. In a separate terminal tab run docker ps, get the Id of the asset builder container, then run docker stop {{ container_id }}.

Once your main wh2o containers are up and running, cd into the wh2o-web root directory, npm install if it's it is the first time running the app, then run npm run serve. This command starts up Webpack dev server on http://localhost:8081/.

Local Component Styleguide

This is not currently being maintained.

We have an existing component library/documentation for custom non-carbon design system components built using vue-styleguidist. To view the library and documentation, cd to wh2o-web root, then run npm run styleguide. This command brings up the guide at http://localhost:6060/. Ports may need to be adjusted to avoid conflicts.

Access Tokens

To get access tokens for third party APIs like Mapbox and Darksky, contact an AW dev team member.

About

https://wh2o-vue.herokuapp.com/#/


Languages

Language:Vue 60.2%Language:JavaScript 25.6%Language:CSS 13.5%Language:HTML 0.8%